Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Subscription

There are 3 ways to subscribe for notifications: by event filters; by subscription id; by subscription data.

Hierarchy

  • EventEmitter
    • Subscription

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

address

address: string

debug

debug: boolean

encryptionKey

encryptionKey: string

eventFilters

eventFilters: string[]

expirationTime

expirationTime: number

id

id: string

pubnub

pubnub: any

refreshTimer

refreshTimer: Timer

rest

rest: RestClient

retryInterval

retryInterval: number = 5000

subscribeKey

subscribeKey: string

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

cancel

  • cancel(): Promise<void>

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

on

  • on(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

onMessage

  • onMessage(listener: function): void

  • Parameters

    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

once

  • once(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

setData

  • setData(subscription: any, reqId?: number): void

  • Set subscription data from referesh, newly created or get by id.

    Parameters

    • subscription: any
    • Optional reqId: number

    Returns void

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

subscribe

  • subscribe(filters?: string[]): Promise<void>

  • expiresIn Optional. Subscription lifetime in seconds. Max value is 7 days (604800 sec) The 'expiresIn' is not supported.

    Errors migh occur: errorCode: 'SUB-505', message: 'Subscriptions limit exceeded'

    Parameters

    • Optional filters: string[]

    Returns Promise<void>

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc