Class IRtmLockAbstract

The IRtmLock class.

This class provides the rtm lock methods that can be invoked by your app.

Hierarchy

  • IRtmLock

Constructors

constructor

Methods

acquireLock getLocks releaseLock removeLock revokeLock setLock

Constructors

constructor

Methods

Abstract acquireLock

  • acquires a lock

    Parameters

    • channelName: string
    • channelType: RtmChannelType
    • lockName: string
    • retry: boolean

    Returns number

    • 0: Success.
    • < 0: Failure.

Abstract getLocks

  • gets locks in the channel

    Parameters

    Returns number

    • 0: Success.
    • < 0: Failure.

Abstract releaseLock

  • releases a lock

    Parameters

    Returns number

    • 0: Success.
    • < 0: Failure.

Abstract removeLock

  • removes a lock

    Parameters

    Returns number

    • 0: Success.
    • < 0: Failure.

Abstract revokeLock

  • disables a lock

    Parameters

    • channelName: string
    • channelType: RtmChannelType
    • lockName: string
    • owner: string

    Returns number

    • 0: Success.
    • < 0: Failure.

Abstract setLock

  • sets a lock

    Parameters

    • channelName: string
    • channelType: RtmChannelType
    • lockName: string
    • ttl: number

    Returns number

    • 0: Success.
    • < 0: Failure.

Settings

Member Visibility

Theme

On This Page