Interface ISubscriptionSDK

interface ISubscriptionSDK {
    ping(peerId?): Promise<SDKProtocolResult>;
    subscribe<T>(decoders, callback, options?): Promise<SDKProtocolResult>;
    unsubscribe(contentTopics): Promise<SDKProtocolResult>;
    unsubscribeAll(): Promise<SDKProtocolResult>;
}

Index

Methods

ping subscribe unsubscribe unsubscribeAll

Methods

ping

ping(peerId?): Promise<SDKProtocolResult>
Parameters
- Optional peerId: PeerId
Returns Promise<SDKProtocolResult>
- Defined in packages/interfaces/dist/filter.d.ts:15

subscribe

subscribe<T>(decoders, callback, options?): Promise<SDKProtocolResult>
Type Parameters
- T extends IDecodedMessage
Parameters
- decoders: IDecoder<T> | IDecoder<T>[]
- callback: Callback<T>
- Optional options: SubscribeOptions
Returns Promise<SDKProtocolResult>
- Defined in packages/interfaces/dist/filter.d.ts:13

unsubscribe

unsubscribe(contentTopics): Promise<SDKProtocolResult>
Parameters
- contentTopics: string[]
Returns Promise<SDKProtocolResult>
- Defined in packages/interfaces/dist/filter.d.ts:14

unsubscribeAll

unsubscribeAll(): Promise<SDKProtocolResult>
Returns Promise<SDKProtocolResult>
- Defined in packages/interfaces/dist/filter.d.ts:16