Skip to main content

Interface: ICustomEventsService

Defined in: src/types/services.ts:321

Custom events service for cross-miniapp communication.

Remarks​

Replaces useCustomEventsObserver hook from the photo editor. The subscribe method is called per miniapp and returns an unsubscribe function that the runtime invokes on miniapp teardown.

Methods​

subscribe()​

subscribe(miniapp): VoidFunction

Defined in: src/types/services.ts:323

Subscribe a miniapp to custom events from other miniapps

Parameters​

miniapp​
appVersion​

string = ...

categoryTags​

string[] = ...

changeLog​

string = ...

createdBy​

{ displayName: string; id: string; photo: string; } = ...

createdBy.displayName​

string = ...

createdBy.id​

string = ...

createdBy.photo​

string = ...

createdOn​

string = ...

description​

string = ...

experience​

"Edit" | "Create" | "Landing" = ...

extensions​

object[] = ...

iconUrl​

string = ...

id​

string = ...

isModuleFederated​

boolean = ...

isPublic​

boolean = ...

isTrusted​

boolean = ...

layout?​

string = ...

name​

string = ...

owners​

object[] = ...

packageId​

string = ...

permissions​

"View"[] = ...

platforms​

("android" | "apple" | "website")[] = ...

platformVersion​

string = ...

productBundle​

string = ...

routes?​

object[] = ...

state​

"Draft" | "Published" = ...

systemTags​

string[] = ...

tags​

string[] = ...

updatedBy​

{ displayName: string; id: string; photo: string; } = ...

updatedBy.displayName​

string = ...

updatedBy.id​

string = ...

updatedBy.photo​

string = ...

updatedOn​

string = ...

workspaceIds​

string[] = ...

Returns​

VoidFunction