Skip to content

Commit 78c92f8

Browse files
author
Evan Greer
committed
feat: adds docs to IterableEmbeddedMessageDefaultAction
1 parent aacfeae commit 78c92f8

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

src/embedded/classes/IterableEmbeddedMessageDefaultAction.ts

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,33 @@
11
export class IterableEmbeddedMessageDefaultAction {
2+
/**
3+
* The type of iterable action
4+
* For custom actions, the type is `action://` prefix followed by a custom action name
5+
*/
26
readonly type: string;
7+
8+
/**
9+
* The url for the action when the type is `openUrl`
10+
* For custom actions, data is empty
11+
*/
312
readonly data?: string;
413

14+
/**
15+
* Creates an instance of `IterableEmbeddedMessageDefaultAction`.
16+
*
17+
* @param type - The type of iterable action
18+
* @param data - The url for the action when the type is `openUrl`
19+
*/
520
constructor(type: string, data?: string) {
621
this.type = type;
722
this.data = data;
823
}
924

25+
/**
26+
* Creates an instance of `IterableEmbeddedMessageDefaultAction` from a dictionary object.
27+
*
28+
* @param dict - The dictionary object containing the properties to initialize the `IterableEmbeddedMessageDefaultAction` instance.
29+
* @returns A new instance of `IterableEmbeddedMessageDefaultAction` initialized with the provided dictionary properties.
30+
*/
1031
static fromDict(
1132
dict: Partial<EmbeddedMessageDefaultActionDict>
1233
): IterableEmbeddedMessageDefaultAction {
@@ -17,6 +38,9 @@ export class IterableEmbeddedMessageDefaultAction {
1738
}
1839
}
1940

41+
/**
42+
* An interface defining the dictionary object containing the properties for the embedded message default action.
43+
*/
2044
export interface EmbeddedMessageDefaultActionDict {
2145
type: string;
2246
data?: string;

0 commit comments

Comments
 (0)