Class SubscriptionAPI

Index

Constructors

Methods

getSubscriptions getViewer postMessage

Constructors

constructor

new SubscriptionAPI(
    key: string,
    secret: string,
    options?: RequestOptions,
): SubscriptionAPI
Parameters
- key: string
- secret: string
- Optionaloptions: RequestOptions
Returns SubscriptionAPI
- Defined in subscription-api.ts:16

Methods

getSubscriptions

getSubscriptions(): Promise<Subscriptions>
Returns Promise<Subscriptions>
- Defined in subscription-api.ts:22

getViewer

getViewer(): Promise<Viewer>
Returns Promise<Viewer>
- Defined in subscription-api.ts:26

postMessage

postMessage(message: string | Message): Promise<SubscriptionPostResponse[]>
Parameters
- message: string | Message
Returns Promise<SubscriptionPostResponse[]>
- Defined in subscription-api.ts:30
postMessage(
message: string | Message,
subscriptionId: string,
): Promise<SubscriptionPostResponse>
Parameters
- message: string | Message
- subscriptionId: string
Returns Promise<SubscriptionPostResponse>
- Defined in subscription-api.ts:33
postMessage(
message: string | Message,
subscriptionIds: string[],
): Promise<SubscriptionPostResponse[]>
Parameters
- message: string | Message
- subscriptionIds: string[]
Returns Promise<SubscriptionPostResponse[]>
- Defined in subscription-api.ts:37