Appearance
From 5474650e72e09ddefe7457824e29c9cab4c36393 Mon Sep 17 00:00:00 2001
From: "flyer-e2e-dispatcher[bot]"
404 Home > @plaidev/karte-action-sdk > ActionChangeStateHook アクションのライフサイクル changeState で呼び出されるフック関数 Signature: References: ActionHook, ActionVariables Home > @plaidev/karte-action-sdk > ActionCloseHook アクションのライフサイクル close で呼び出されるフックする関数 Signature: References: ActionHook, ActionVariables, CloseTrigger Home > @plaidev/karte-action-sdk > ActionEventHandler アクションのイベントハンドラ Signature: Home > @plaidev/karte-action-sdk > ActionHook アクションのライフサイクルで呼び出されるフック Signature: References: ActionProps, ActionVariables
-
+
diff --git a/docs/hashmap.json b/docs/hashmap.json
index 5cf80a7a..4f983b23 100644
--- a/docs/hashmap.json
+++ b/docs/hashmap.json
@@ -1 +1 @@
-{"karte-action-sdk.actionoptions.localvariablesquery.md":"f2743a17","karte-action-sdk.actionchangestatehook.md":"f2ab4cec","karte-action-sdk.applycss.md":"b2ff30c9","karte-action-sdk.actionprops.md":"aaf0199c","karte-action-sdk.onscrollcontext.deltarate.md":"baf3a3c4","karte-action-sdk.actionoptions.kartetemplate.md":"bc36e9aa","karte-action-sdk.actionprops.onchangestate.md":"8c495630","karte-action-sdk.applyglobalcss.md":"34b6140c","karte-action-sdk.beforeupdate.md":"8784ae30","karte-action-sdk.addfreeanswer.md":"3304b740","karte-action-sdk.onclose.md":"970e1586","karte-action-sdk.actionprops.data.md":"fdde7870","index.md":"84bed5e4","karte-action-sdk.addchoiceanswer.md":"c5f8c984","karte-action-sdk.oncreate.md":"2cb8f114","karte-action-sdk.getansweredquestionids.md":"595b9933","karte-action-sdk.collectionconfig.md":"3e36e744","karte-action-sdk.getansweredquestion.md":"00a748e6","karte-action-sdk.actioneventhandler.md":"d69b5bb0","karte-action-sdk.actionprops.send.md":"a8cf8ade","karte-action-sdk.onmount.md":"4c6f9b2d","karte-action-sdk.actionprops.publish.md":"16831e27","karte-action-sdk.widget.actionoptions.variables.md":"10a564b3","karte-action-sdk.onscroll.md":"8d36a80e","karte-action-sdk.ondestory.md":"8cd09c35","karte-action-sdk.widget.actionprops.data.md":"255e7201","karte-action-sdk.actionprops.onshow.md":"4bb009c5","karte-action-sdk.actionoptions.variables.md":"64073d3d","karte-action-sdk.ontime.md":"e95f405d","karte-action-sdk.scrolldirection.md":"e885b6b8","karte-action-sdk.widget.actionvariables.md":"77db2175","karte-action-sdk.layout_component_names.md":"f1aba921","karte-action-sdk.widget.actionprops.md":"9adfe2aa","karte-action-sdk.widget.actionprops.onchangestate.md":"ae46b0e7","karte-action-sdk.widget.actionprops.onshow.md":"8586d6d8","karte-action-sdk.widget.actionprops.publish.md":"10dc4f97","karte-action-sdk.widget.actionprops.send.md":"d27a3089","karte-action-sdk.widget.actionrunnercontext.md":"eb1c90f7","karte-action-sdk.getsystem.md":"71cb5a4a","karte-action-sdk.getvariables.md":"c665c336","karte-action-sdk.actionoptions.context.md":"6b78ff7a","karte-action-sdk.actionhook.md":"bcb7544b","karte-action-sdk.widget.actionsetting.md":"5f2fe8c1","karte-action-sdk.widget.actiontablequeryparam.md":"c6c23e35","karte-action-sdk.widget.collectionconfig.md":"29c33e7f","karte-action-sdk.collection.md":"f37ced42","karte-action-sdk.onchangestate.md":"4c8c04ac","karte-action-sdk.onscrollcontext.rate.md":"b768ff2c","karte-action-sdk.isopened.md":"38c9a592","karte-action-sdk.widget.getmemorystore.md":"dbcfc38b","karte-action-sdk.widget.getstate.md":"b77396c1","karte-action-sdk.widget.sendfunction.md":"6c2c4885","karte-action-sdk.actionclosehook.md":"cdbe19d4","karte-action-sdk.widget.getlocalstore.md":"5a59527f","karte-action-sdk.widget.publishfunction.md":"db15e16d","karte-action-sdk.actionoptions.publish.md":"612dfa38","karte-action-sdk.resetvariables.md":"9f532c5a","karte-action-sdk.widget.on.md":"8b0b4f12","karte-action-sdk.widget.onchangeval.md":"fa6a6191","karte-action-sdk.widget.setmemorystore.md":"f9f0181c","karte-action-sdk.widget.getactionroot.md":"dc97adc4","karte-action-sdk.widget.collection_0.md":"0172f512","karte-action-sdk.widget.applycss.md":"204a448c","karte-action-sdk.widget.eventcallback.md":"23586815","karte-action-sdk.actionoptions.oncreate.md":"8e99c357","karte-action-sdk.widget.changevalcallback.md":"0b460291","karte-action-sdk.onscrollcontext.previousrate.md":"9e030e98","karte-action-sdk.widget.closeaction.md":"27a3a52a","karte-action-sdk.widget.closetrigger.md":"1af996e8","karte-action-sdk.widget.collection.md":"9c413349","karte-action-sdk.destroyaction.md":"4a987480","karte-action-sdk.formidentifytextfields.md":"7756e0aa","karte-action-sdk.font.md":"a6c0ec5e","karte-action-sdk.sendfunction.md":"7004b8f5","karte-action-sdk.widget.getcssvariables.md":"5070825f","karte-action-sdk.create.md":"c1a4eca6","karte-action-sdk.reseteventhandlers.md":"5fc335b1","karte-action-sdk.getactionroot.md":"46ce5883","karte-action-sdk.md":"aa307ef5","karte-action-sdk.actionoptions.md":"586ce54b","karte-action-sdk.actionvariables.md":"694551ae","karte-action-sdk.seteventhandlers.md":"ad502dc5","karte-action-sdk.setstate.md":"af099dd2","karte-action-sdk.showaction.md":"893d0430","karte-action-sdk.setsetting.md":"c00944b0","karte-action-sdk.onscrollcontext.scrollrate.md":"ebce401d","karte-action-sdk.afterupdate.md":"e26ac116","karte-action-sdk.setvariables.md":"fccb8a6d","karte-action-sdk.widget.actionchangestatehook.md":"8b157a5d","karte-action-sdk.widget.actionoptions.context.md":"912c6adf","karte-action-sdk.onscrollfunction.md":"25c085be","karte-action-sdk.loadglobalstyle.md":"54463790","karte-action-sdk.widget.onchangestate.md":"985aa8db","karte-action-sdk.widget.onclose.md":"fdde8206","karte-action-sdk.widget.modalprops.md":"7f8f514f","karte-action-sdk.widget.actionoptions.oncreate.md":"4640715b","karte-action-sdk.widget.actionoptions.publish.md":"301eda6e","karte-action-sdk.getcssvariables.md":"374293d9","karte-action-sdk.sendanswer.md":"77ea7316","karte-action-sdk.sendanswers.md":"3bf4ccfc","karte-action-sdk.widget.actionoptions.props.md":"8618b1c6","karte-action-sdk.getstate.md":"b5c9da77","karte-action-sdk.widget.setstate.md":"8148ed3d","karte-action-sdk.widget.actionhook.md":"f5fe416f","karte-action-sdk.systemconfig.md":"7f67572c","karte-action-sdk.widget.setval.md":"1e4c5cbb","karte-action-sdk.widget.storage.md":"77237684","karte-action-sdk.widget.actionoptions.md":"ae47784e","karte-action-sdk.widget.actionoptions.localvariablesquery.md":"ee872611","karte-action-sdk.widget.systemconfig.md":"a2bd832c","karte-action-sdk.widget.actionoptions.send.md":"3c48cb6c","karte-action-sdk.widget.showaction.md":"13f4b036","karte-action-sdk.widget.widgeteventname.md":"e52b6807","karte-action-sdk.widget.onshow.md":"89c8ba6e","karte-action-sdk.onscrollcontext.md":"8d62ceb1","karte-action-sdk.closetrigger.md":"19d19a82","karte-action-sdk.onscrollcontext.direction.md":"147f6d33","karte-action-sdk.widget.getval.md":"615b7b95","karte-action-sdk.closeaction.md":"7b41f72a","karte-action-sdk.loadglobalscript.md":"9676174c","karte-action-sdk.widget.md":"3fecaca3","karte-action-sdk.actionoptions.send.md":"19c528d1","karte-action-sdk.publishfunction.md":"89185195","karte-action-sdk.getstates.md":"dc135398","karte-action-sdk.widget.setlocalstore.md":"d2e998a0","karte-action-sdk.actionoptions.props.md":"73667d0b","karte-action-sdk.widget.actiontablequeryparams.md":"95915856","karte-action-sdk.tick.md":"681bb7e0","karte-action-sdk.loadstyle.md":"c44c2fa3","karte-action-sdk.widget.actionoptions.kartetemplate.md":"f42bd199","karte-action-sdk.widget.actiontableresult.md":"26aed84f","karte-action-sdk.widget.loadstyle.md":"ce23aaa6","karte-action-sdk.widget.method.md":"c608a5a0","karte-action-sdk.removeanswer.md":"9b46bb32","karte-action-sdk.widget.actioneventhandler.md":"24092b69","karte-action-sdk.onshow.md":"d1e11e41","karte-action-sdk.widget.actionclosehook.md":"49ed0433","karte-action-sdk.geteventhandlers.md":"b5376573","karte-action-sdk.ondestroy.md":"045a85c9"}
+{"index.md":"84bed5e4","karte-action-sdk.sendanswers.md":"3bf4ccfc","karte-action-sdk.onscrollcontext.scrollrate.md":"ebce401d","karte-action-sdk.actionclosehook.md":"cdbe19d4","karte-action-sdk.actionoptions.context.md":"6b78ff7a","karte-action-sdk.onshow.md":"d1e11e41","karte-action-sdk.getansweredquestionids.md":"595b9933","karte-action-sdk.actionoptions.localvariablesquery.md":"f2743a17","karte-action-sdk.actionoptions.md":"586ce54b","karte-action-sdk.actionoptions.oncreate.md":"8e99c357","karte-action-sdk.actionoptions.publish.md":"612dfa38","karte-action-sdk.actionoptions.props.md":"73667d0b","karte-action-sdk.actionoptions.send.md":"19c528d1","karte-action-sdk.actionprops.md":"aaf0199c","karte-action-sdk.actionprops.onchangestate.md":"8c495630","karte-action-sdk.actionprops.onshow.md":"4bb009c5","karte-action-sdk.applyglobalcss.md":"34b6140c","karte-action-sdk.addchoiceanswer.md":"c5f8c984","karte-action-sdk.actionprops.publish.md":"16831e27","karte-action-sdk.actionoptions.variables.md":"64073d3d","karte-action-sdk.actionprops.data.md":"fdde7870","karte-action-sdk.closetrigger.md":"19d19a82","karte-action-sdk.afterupdate.md":"e26ac116","karte-action-sdk.applycss.md":"b2ff30c9","karte-action-sdk.collectionconfig.md":"3e36e744","karte-action-sdk.actionchangestatehook.md":"f2ab4cec","karte-action-sdk.collection.md":"f37ced42","karte-action-sdk.closeaction.md":"7b41f72a","karte-action-sdk.geteventhandlers.md":"b5376573","karte-action-sdk.getstate.md":"b5c9da77","karte-action-sdk.getstates.md":"dc135398","karte-action-sdk.getsystem.md":"71cb5a4a","karte-action-sdk.getvariables.md":"c665c336","karte-action-sdk.isopened.md":"38c9a592","karte-action-sdk.layout_component_names.md":"f1aba921","karte-action-sdk.loadglobalscript.md":"9676174c","karte-action-sdk.loadglobalstyle.md":"54463790","karte-action-sdk.loadstyle.md":"c44c2fa3","karte-action-sdk.onchangestate.md":"4c8c04ac","karte-action-sdk.oncreate.md":"2cb8f114","karte-action-sdk.onclose.md":"970e1586","karte-action-sdk.md":"aa307ef5","karte-action-sdk.onscroll.md":"8d36a80e","karte-action-sdk.ondestory.md":"8cd09c35","karte-action-sdk.onmount.md":"4c6f9b2d","karte-action-sdk.ondestroy.md":"045a85c9","karte-action-sdk.onscrollcontext.md":"8d62ceb1","karte-action-sdk.widget.actionprops.send.md":"d27a3089","karte-action-sdk.widget.actionprops.onshow.md":"8586d6d8","karte-action-sdk.widget.actionprops.publish.md":"10dc4f97","karte-action-sdk.widget.actionprops.onchangestate.md":"ae46b0e7","karte-action-sdk.widget.actiontablequeryparams.md":"95915856","karte-action-sdk.widget.actionvariables.md":"77db2175","karte-action-sdk.onscrollcontext.rate.md":"b768ff2c","karte-action-sdk.widget.applycss.md":"204a448c","karte-action-sdk.widget.actionprops.md":"9adfe2aa","karte-action-sdk.widget.changevalcallback.md":"0b460291","karte-action-sdk.widget.getmemorystore.md":"dbcfc38b","karte-action-sdk.widget.closeaction.md":"27a3a52a","karte-action-sdk.widget.closetrigger.md":"1af996e8","karte-action-sdk.widget.actiontablequeryparam.md":"c6c23e35","karte-action-sdk.widget.collectionconfig.md":"29c33e7f","karte-action-sdk.widget.actionoptions.localvariablesquery.md":"ee872611","karte-action-sdk.widget.collection.md":"9c413349","karte-action-sdk.widget.setlocalstore.md":"d2e998a0","karte-action-sdk.scrolldirection.md":"e885b6b8","karte-action-sdk.resetvariables.md":"9f532c5a","karte-action-sdk.widget.actionoptions.oncreate.md":"4640715b","karte-action-sdk.widget.actionoptions.md":"ae47784e","karte-action-sdk.sendanswer.md":"77ea7316","karte-action-sdk.widget.actionoptions.props.md":"8618b1c6","karte-action-sdk.widget.actionoptions.send.md":"3c48cb6c","karte-action-sdk.widget.actionoptions.publish.md":"301eda6e","karte-action-sdk.sendfunction.md":"7004b8f5","karte-action-sdk.widget.actionoptions.variables.md":"10a564b3","karte-action-sdk.seteventhandlers.md":"ad502dc5","karte-action-sdk.font.md":"a6c0ec5e","karte-action-sdk.setsetting.md":"c00944b0","karte-action-sdk.setstate.md":"af099dd2","karte-action-sdk.formidentifytextfields.md":"7756e0aa","karte-action-sdk.setvariables.md":"fccb8a6d","karte-action-sdk.getansweredquestion.md":"00a748e6","karte-action-sdk.getactionroot.md":"46ce5883","karte-action-sdk.widget.actionprops.data.md":"255e7201","karte-action-sdk.actionprops.send.md":"a8cf8ade","karte-action-sdk.showaction.md":"893d0430","karte-action-sdk.actionoptions.kartetemplate.md":"bc36e9aa","karte-action-sdk.actioneventhandler.md":"d69b5bb0","karte-action-sdk.actionhook.md":"bcb7544b","karte-action-sdk.addfreeanswer.md":"3304b740","karte-action-sdk.beforeupdate.md":"8784ae30","karte-action-sdk.actionvariables.md":"694551ae","karte-action-sdk.destroyaction.md":"4a987480","karte-action-sdk.onscrollcontext.direction.md":"147f6d33","karte-action-sdk.systemconfig.md":"7f67572c","karte-action-sdk.create.md":"c1a4eca6","karte-action-sdk.getcssvariables.md":"374293d9","karte-action-sdk.reseteventhandlers.md":"5fc335b1","karte-action-sdk.onscrollcontext.previousrate.md":"9e030e98","karte-action-sdk.onscrollfunction.md":"25c085be","karte-action-sdk.widget.actionchangestatehook.md":"8b157a5d","karte-action-sdk.widget.actionrunnercontext.md":"eb1c90f7","karte-action-sdk.widget.actionclosehook.md":"49ed0433","karte-action-sdk.widget.actioneventhandler.md":"24092b69","karte-action-sdk.widget.on.md":"8b0b4f12","karte-action-sdk.widget.onchangeval.md":"fa6a6191","karte-action-sdk.widget.onclose.md":"fdde8206","karte-action-sdk.widget.onchangestate.md":"985aa8db","karte-action-sdk.widget.publishfunction.md":"db15e16d","karte-action-sdk.publishfunction.md":"89185195","karte-action-sdk.widget.onshow.md":"89c8ba6e","karte-action-sdk.widget.sendfunction.md":"6c2c4885","karte-action-sdk.removeanswer.md":"9b46bb32","karte-action-sdk.widget.actionoptions.context.md":"912c6adf","karte-action-sdk.widget.setmemorystore.md":"f9f0181c","karte-action-sdk.widget.setstate.md":"8148ed3d","karte-action-sdk.widget.setval.md":"1e4c5cbb","karte-action-sdk.widget.showaction.md":"13f4b036","karte-action-sdk.widget.actiontableresult.md":"26aed84f","karte-action-sdk.widget.getval.md":"615b7b95","karte-action-sdk.widget.widgeteventname.md":"e52b6807","karte-action-sdk.widget.loadstyle.md":"ce23aaa6","karte-action-sdk.widget.actionhook.md":"f5fe416f","karte-action-sdk.widget.storage.md":"77237684","karte-action-sdk.widget.systemconfig.md":"a2bd832c","karte-action-sdk.widget.actionsetting.md":"5f2fe8c1","karte-action-sdk.widget.md":"3fecaca3","karte-action-sdk.widget.getactionroot.md":"dc97adc4","karte-action-sdk.widget.collection_0.md":"0172f512","karte-action-sdk.onscrollcontext.deltarate.md":"baf3a3c4","karte-action-sdk.widget.eventcallback.md":"23586815","karte-action-sdk.widget.getlocalstore.md":"5a59527f","karte-action-sdk.tick.md":"681bb7e0","karte-action-sdk.widget.method.md":"c608a5a0","karte-action-sdk.ontime.md":"e95f405d","karte-action-sdk.widget.modalprops.md":"7f8f514f","karte-action-sdk.widget.actionoptions.kartetemplate.md":"f42bd199","karte-action-sdk.widget.getcssvariables.md":"5070825f","karte-action-sdk.widget.getstate.md":"b77396c1"}
diff --git a/docs/index.html b/docs/index.html
index f49064f3..86dc986b 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -13,7 +13,7 @@
Skip to content PAGE NOT FOUND
But if you don't change your direction, and if you keep looking, you may end up where you are heading.
-
+
diff --git a/docs/karte-action-sdk.actionchangestatehook.html b/docs/karte-action-sdk.actionchangestatehook.html
index 08a74a61..7b6835e2 100644
--- a/docs/karte-action-sdk.actionchangestatehook.html
+++ b/docs/karte-action-sdk.actionchangestatehook.html
@@ -14,7 +14,7 @@
-
+
diff --git a/docs/karte-action-sdk.actionclosehook.html b/docs/karte-action-sdk.actionclosehook.html
index 706ac470..a7b13b2e 100644
--- a/docs/karte-action-sdk.actionclosehook.html
+++ b/docs/karte-action-sdk.actionclosehook.html
@@ -14,7 +14,7 @@
Skip to content On this pageActionChangeStateHook type
typescripttype ActionChangeStateHook<Props, Variables> = (props: Parameters<ActionHook<Props, Variables & ActionVariables>>[0], newState: string) => void | Promise<void>;
-
+
diff --git a/docs/karte-action-sdk.actioneventhandler.html b/docs/karte-action-sdk.actioneventhandler.html
index cdd50785..91caca95 100644
--- a/docs/karte-action-sdk.actioneventhandler.html
+++ b/docs/karte-action-sdk.actioneventhandler.html
@@ -14,7 +14,7 @@
Skip to content On this pageActionCloseHook type
typescripttype ActionCloseHook<Props extends ModalProps$1, Variables> = (props: Parameters<ActionHook<Props, Variables & ActionVariables>>[0], trigger: CloseTrigger) => void | Promise<void>;
-
+
diff --git a/docs/karte-action-sdk.actionhook.html b/docs/karte-action-sdk.actionhook.html
index 5328e1a5..56bb4ad8 100644
--- a/docs/karte-action-sdk.actionhook.html
+++ b/docs/karte-action-sdk.actionhook.html
@@ -14,7 +14,7 @@
Skip to content On this pageActionEventHandler type
typescripttype ActionEventHandler = (...args: any[]) => any | Promise<any>;
-
+
diff --git a/docs/karte-action-sdk.actionoptions.context.html b/docs/karte-action-sdk.actionoptions.context.html
index 4b04bf8c..728d771d 100644
--- a/docs/karte-action-sdk.actionoptions.context.html
+++ b/docs/karte-action-sdk.actionoptions.context.html
@@ -14,7 +14,7 @@
Skip to content On this pageActionHook type
typescripttype ActionHook<Props, Variables> = (props: ActionProps<Props, Variables & ActionVariables>) => void | Promise<void>;
-
+
diff --git a/docs/karte-action-sdk.actionoptions.html b/docs/karte-action-sdk.actionoptions.html
index 3ccfb457..3a6a2e2e 100644
--- a/docs/karte-action-sdk.actionoptions.html
+++ b/docs/karte-action-sdk.actionoptions.html
@@ -14,7 +14,7 @@
-
+
diff --git a/docs/karte-action-sdk.actionoptions.kartetemplate.html b/docs/karte-action-sdk.actionoptions.kartetemplate.html
index 87a4ef0f..dfcefb2b 100644
--- a/docs/karte-action-sdk.actionoptions.kartetemplate.html
+++ b/docs/karte-action-sdk.actionoptions.kartetemplate.html
@@ -16,7 +16,7 @@
[key: string]: any;
};
-
+
Home > @plaidev/karte-action-sdk > ActionProps > data
アクションで使用されるデータ
Signature:
data: Props & Variables & ActionVariables;
Home > @plaidev/karte-action-sdk > ActionProps
アクションのプロパティ
Signature:
interface ActionProps<Props, Variables>
Property | Modifiers | Type | Description |
---|---|---|---|
data | Props & Variables & ActionVariables | アクションで使用されるデータ | |
onChangeState? | ActionChangeStateHook<Props, Variables & ActionVariables> | (Optional) アクションのステートが変更されたときにフックされる onChangeState() | |
onShow? | ActionHook<Props, Variables & ActionVariables> | (Optional) アクションが表示されたときにフックされる onShow() | |
publish | PublishFunction | アクション内でタグのQueueにリクエストを発行する関数 | |
send | SendFunction | アクションでイベントがトリガーされたときに受信するための関数 |
Home > @plaidev/karte-action-sdk > ActionProps > onChangeState
アクションのステートが変更されたときにフックされる onChangeState()
Signature:
onChangeState?: ActionChangeStateHook<Props, Variables & ActionVariables>;
Home > @plaidev/karte-action-sdk > ActionProps > onShow
アクションが表示されたときにフックされる onShow()
Signature:
onShow?: ActionHook<Props, Variables & ActionVariables>;
Home > @plaidev/karte-action-sdk > ActionProps > publish
アクション内でタグのQueueにリクエストを発行する関数
Signature:
publish: PublishFunction;
Home > @plaidev/karte-action-sdk > ActionProps > send
アクションでイベントがトリガーされたときに受信するための関数
Signature:
send: SendFunction;
Home > @plaidev/karte-action-sdk > afterUpdate
エレメントを更新した後に実行される関数の登録
Signature:
afterUpdate: typeof afterUpdateSvelte
Home > @plaidev/karte-action-sdk > applyCss
アクションに CSS を適用する
Signature:
declare function applyCss(css: string): Promise<HTMLStyleElement>;
Parameter | Type | Description |
---|---|---|
css | string | 適用する CSS |
Returns:
Promise<HTMLStyleElement>
適用された style 要素を返す Promise
Home > @plaidev/karte-action-sdk > applyGlobalCss
グローバル CSS をページに適用する
Signature:
declare function applyGlobalCss(css: string): Promise<any>;
Parameter | Type | Description |
---|---|---|
css | string | CSS |
Returns:
Promise<any>
Home > @plaidev/karte-action-sdk > beforeUpdate
エレメントを更新する前に実行される関数の登録
Signature:
beforeUpdate: typeof beforeUpdateSvelte
Home > @plaidev/karte-action-sdk > closeAction
アクションを閉じる
Signature:
declare function closeAction(trigger?: CloseTrigger): void;
Parameter | Type | Description |
---|---|---|
trigger | CloseTrigger | (Optional) 閉じた時のトリガー。デフォルト 'none' |
Returns:
void
Home > @plaidev/karte-action-sdk > CloseTrigger
閉じるアクショントリガー
Signature:
type CloseTrigger = "button" | "overlay" | "auto" | "none";
Home > @plaidev/karte-action-sdk > create
アクションを作成する
Signature:
declare function create<Props extends ModalProps, Variables, VariablesQuery extends Array<VariableQuery>>(App: typeof SvelteComponentDev, options?: ActionOptions<Props, Variables & ActionVariables, VariablesQuery>): () => void;
Parameter | Type | Description |
---|---|---|
App | typeof SvelteComponentDev | Svelte コンポーネントのエントリポイント |
options | ActionOptions<Props, Variables & ActionVariables, VariablesQuery> | (Optional) オプション |
Returns:
() => void
アクションを破棄する関数
Home > @plaidev/karte-action-sdk > destroyAction
アクションの破棄する
Signature:
declare function destroyAction(): void;
Returns:
void
Home > @plaidev/karte-action-sdk > Font
Signature:
type Font = (typeof Fonts)[number];
Home > @plaidev/karte-action-sdk > getActionRoot
アクションのルートの DOM 要素を取得する
Signature:
declare function getActionRoot(): ShadowRoot | null;
Returns:
ShadowRoot | null
アクションがルートの DOM 要素 を持つ場合は DOM 要素を返します。ない場合は null
を返します
Home > @plaidev/karte-action-sdk > getAnsweredQuestion
回答済の回答内容を取得する
Signature:
declare function getAnsweredQuestion(questionId: string): AnswerValue | undefined;
Parameter | Type | Description |
---|---|---|
questionId | string | 質問ID |
Returns:
AnswerValue | undefined
回答データ
Home > @plaidev/karte-action-sdk > getAnsweredQuestionIds
回答済の回答IDのリストを取得
Signature:
declare function getAnsweredQuestionIds(): string[];
Returns:
string[]
回答済の質問の質問IDの配列
Home > @plaidev/karte-action-sdk > getState
現在のステートを取得する
Signature:
declare function getState(): string;
Returns:
string
現在のステートID
アクションが表示されて設定されるため、onShow() フック関数で利用できます。
Home > @plaidev/karte-action-sdk > getStates
ステートID一覧を取得する
Signature:
declare function getStates(): string[];
Returns:
string[]
すべてのステートID
アクションが表示されて設定されるため、onShow() フック関数で利用できます。
Home > @plaidev/karte-action-sdk > getSystem
KARTE の設定を取得する
Signature:
declare function getSystem(): SystemConfig;
Returns:
現在の KARTE システムの設定を返します
アクションが表示されて設定されるため、onShow() フック関数で利用できます。 取得できる設定は、APIキー、接客ID、アクションショートIDなどです。
Home > @plaidev/karte-action-sdk > getVariables
変数の一覧を取得する
Signature:
declare function getVariables(): ActionVariables;
Returns:
現在の変数の一覧
Home > @plaidev/karte-action-sdk
Interface | Description |
---|---|
ActionOptions | create() 向けのオプション |
ActionProps | アクションのプロパティ |
OnScrollContext | onScroll() のスクロールコンテキスト情報 |
Namespace | Description |
---|---|
widget |
Variable | Description |
---|---|
afterUpdate | エレメントを更新した後に実行される関数の登録 |
beforeUpdate | エレメントを更新する前に実行される関数の登録 |
FormIdentifyTextFields | |
LAYOUT_COMPONENT_NAMES | |
onDestory | エレメントを破棄したときに実行される関数の登録 |
onMount | エレメントをマウントしたときに実行される関数の登録 |
tick | エレメントのライフサイクルを進める |
Type Alias | Description |
---|---|
ActionChangeStateHook | アクションのライフサイクル changeState で呼び出されるフック関数 |
ActionCloseHook | アクションのライフサイクル close で呼び出されるフックする関数 |
ActionEventHandler | アクションのイベントハンドラ |
ActionHook | アクションのライフサイクルで呼び出されるフック |
ActionVariables | アクションの変数 |
CloseTrigger | 閉じるアクショントリガー |
CollectionConfig | アクションテーブルの設定情報 |
Font | |
OnScrollFunction | onScroll() によって呼び出されるコールバック関数 |
PublishFunction | アクションの publish 関数 |
ScrollDirection | スクロール方向 |
SendFunction | アクションの send 関数 |
SystemConfig | KARTE のシステム設定情報 |
Home > @plaidev/karte-action-sdk > isOpened
アクションの表示・非表示の状態を取得する
Signature:
declare function isOpened(): boolean;
Returns:
boolean
アクションが表示されているときは true
、非表示のときは false
を返します。
Home > @plaidev/karte-action-sdk > LAYOUT_COMPONENT_NAMES
Signature:
LAYOUT_COMPONENT_NAMES: string[]
Home > @plaidev/karte-action-sdk > loadGlobalScript
ES Modules に対応していない JavaScript をページに読み込む
Signature:
declare function loadGlobalScript(src: string): Promise<any>;
Parameter | Type | Description |
---|---|---|
src | string | JavaScript ファイルのリンク URL |
Returns:
Promise<any>
Home > @plaidev/karte-action-sdk > loadGlobalStyle
style ファイルをページに読み込む
Signature:
declare function loadGlobalStyle(href: string): Promise<any>;
Parameter | Type | Description |
---|---|---|
href | string | style ファイルのリンク URL |
Returns:
Promise<any>
Home > @plaidev/karte-action-sdk > loadStyle
アクションにグローバルなスタイルを読み込む
Signature:
declare function loadStyle(href: string): Promise<void>;
Parameter | Type | Description |
---|---|---|
href | string | style ファイルのリンク URL |
Returns:
Promise<void>
Home > @plaidev/karte-action-sdk > onChangeState
アクションのステートが変更された (changeState) 後にフックする関数
Signature:
declare function onChangeState<Props extends ModalProps$1, Variables>(fn: ActionChangeStateHook<Props, Variables & ActionVariables>): void;
Parameter | Type | Description |
---|---|---|
fn | ActionChangeStateHook<Props, Variables & ActionVariables> | 呼び出されるフック関数 |
Returns:
void
Home > @plaidev/karte-action-sdk > onClose
アクションがクローズ (close) される前にフックする関数
Signature:
declare function onClose<Props extends ModalProps$1, Variables>(fn: ActionCloseHook<Props, Variables & ActionVariables>): void;
Parameter | Type | Description |
---|---|---|
fn | ActionCloseHook<Props, Variables & ActionVariables> | 呼び出されるフック関数 |
Returns:
void
Home > @plaidev/karte-action-sdk > onCreate
アクションが作成 (create) される前にフックする関数
Signature:
declare function onCreate<Props extends ModalProps, Variables>(fn: ActionHook<Props, Variables & ActionVariables>): void;
Parameter | Type | Description |
---|---|---|
fn | ActionHook<Props, Variables & ActionVariables> | 呼び出されるフック関数 |
Returns:
void
Home > @plaidev/karte-action-sdk > onDestory
エレメントを破棄したときに実行される関数の登録
Signature:
onDestory: typeof onDestorySvelte
Home > @plaidev/karte-action-sdk > onDestroy
アクションが破棄 (destroy) される前にフックする関数
Signature:
declare function onDestroy<Props extends ModalProps, Variables>(fn: ActionHook<Props, Variables & ActionVariables>): void;
Parameter | Type | Description |
---|---|---|
fn | ActionHook<Props, Variables & ActionVariables> | 呼び出されるフック関数 |
Returns:
void
Home > @plaidev/karte-action-sdk > onMount
エレメントをマウントしたときに実行される関数の登録
Signature:
onMount: typeof onMountSvelte
Home > @plaidev/karte-action-sdk > onScroll
スクロール率が達したときに呼び出すコールバックを登録します
Signature:
declare function onScroll(rate: number | number[], fn: OnScrollFunction): () => void;
Parameter | Type | Description |
---|---|---|
rate | number | number[] | スクロール率。この値は viewport でのスクロールのパーセンテージ |
fn | OnScrollFunction | スクロール率が達したときに呼び出されるコールバック関数 |
Returns:
() => void
スクロール率によって呼び出されるコールバックを停止する関数を返します
Home > @plaidev/karte-action-sdk > OnScrollContext > deltaRate
現在のスクロール率と前のスクロール率との差分値
Signature:
deltaRate: number;
Home > @plaidev/karte-action-sdk > OnScrollContext > direction
スクロール方向
Signature:
direction: ScrollDirection;
Home > @plaidev/karte-action-sdk > OnScrollContext
onScroll() のスクロールコンテキスト情報
Signature:
interface OnScrollContext
このコンテキスト情報は、OnScrollFunction が呼び出されたタイミングの情報が格納されています
Property | Modifiers | Type | Description |
---|---|---|---|
deltaRate | number | 現在のスクロール率と前のスクロール率との差分値 | |
direction | ScrollDirection | スクロール方向 | |
previousRate | number | 前のスクロール率 | |
rate | number | onScroll() によって指定されたスクロール率 | |
scrollRate | number | ページのスクロール率 |
Home > @plaidev/karte-action-sdk > OnScrollContext > previousRate
前のスクロール率
Signature:
previousRate: number;
Home > @plaidev/karte-action-sdk > OnScrollContext > rate
onScroll() によって指定されたスクロール率
Signature:
rate: number;
Home > @plaidev/karte-action-sdk > OnScrollContext > scrollRate
ページのスクロール率
Signature:
scrollRate: number;
Home > @plaidev/karte-action-sdk > OnScrollFunction
onScroll() によって呼び出されるコールバック関数
Signature:
type OnScrollFunction = (ctx: OnScrollContext) => boolean;
References: OnScrollContext
Home > @plaidev/karte-action-sdk > onShow
アクションが表示 (show) された後にフックする関数
Signature:
declare function onShow<Props extends ModalProps$1, Variables>(fn: ActionHook<Props, Variables & ActionVariables>): void;
Parameter | Type | Description |
---|---|---|
fn | ActionHook<Props, Variables & ActionVariables> | 呼び出されるフック関数 |
Returns:
void
Home > @plaidev/karte-action-sdk > onTime
指定した時間の経過後に呼び出すコールバックを登録します
Signature:
declare function onTime(time: number, fn: Function): () => void;
Parameter | Type | Description |
---|---|---|
time | number | コールバックを呼び出すまでの時間。単位はミリセカンド(ms) |
fn | Function | 指定した時間が経過後に呼び出されるコールバック関数 |
Returns:
() => void
コールバックを呼び出すためのタイマーを停止する関数を返します
Home > @plaidev/karte-action-sdk > PublishFunction
アクションの publish 関数
Signature:
type PublishFunction = (topic: string, values?: any) => void;
Home > @plaidev/karte-action-sdk > removeAnswer
回答済の回答を削除
Signature:
declare function removeAnswer(questionId: string): void;
Parameter | Type | Description |
---|---|---|
questionId | string | 質問ID |
Returns:
void
Home > @plaidev/karte-action-sdk > resetEventHandlers
イベントハンドラーをリセットする
Signature:
declare function resetEventHandlers(): void;
Returns:
void
Home > @plaidev/karte-action-sdk > resetVariables
変数をリセットする
Signature:
declare function resetVariables(): void;
Returns:
void
Home > @plaidev/karte-action-sdk > ScrollDirection
スクロール方向
Signature:
type ScrollDirection = "up" | "down";
Home > @plaidev/karte-action-sdk > sendAnswer
sendAnswers
のエイリアス
Signature:
declare function sendAnswer(): boolean;
Returns:
boolean
Home > @plaidev/karte-action-sdk > sendAnswers
回答済の回答をまとめてイベントとして送信する
Signature:
declare function sendAnswers(): boolean;
Returns:
boolean
イベント送信の成功/失敗
Home > @plaidev/karte-action-sdk > SendFunction
アクションの send 関数
Signature:
type SendFunction = (event_name: string, values?: any) => void;
Home > @plaidev/karte-action-sdk > setSetting
アクション設定を更新する
Signature:
declare function setSetting(setting: ActionSetting): ActionSetting;
Parameter | Type | Description |
---|---|---|
setting | ActionSetting | 更新するアクション設定 |
Returns:
ActionSetting
新しいアクション設定
Home > @plaidev/karte-action-sdk > setVariables
変数を設定する
Signature:
declare function setVariables(vars: ActionVariables): ActionVariables;
Parameter | Type | Description |
---|---|---|
vars | ActionVariables | 変数 |
Returns:
設定した変数は、ビジュアルエディタのテキストフォームなどで利用できます。
Home > @plaidev/karte-action-sdk > showAction
アクションを表示する
Signature:
declare function showAction(): void;
Returns:
void
Home > @plaidev/karte-action-sdk > tick
エレメントのライフサイクルを進める
Signature:
tick: typeof tickSvelte