Class IRtmLockAbstract

The IRtmLock class.

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

Hierarchy

  • IRtmLock

Constructors

Methods

  • acquires a lock

    Parameters

    • channelName: string
    • channelType: RTM_CHANNEL_TYPE
    • lockName: string
    • retry: boolean
    • Optional requestId: number

    Returns number

    • 0: Success.
    • < 0: Failure.
  • gets locks in the channel

    Parameters

    Returns number

    • 0: Success.
    • < 0: Failure.
  • releases a lock

    Parameters

    • channelName: string
    • channelType: RTM_CHANNEL_TYPE
    • lockName: string
    • Optional requestId: number

    Returns number

    • 0: Success.
    • < 0: Failure.
  • removes a lock

    Parameters

    • channelName: string
    • channelType: RTM_CHANNEL_TYPE
    • lockName: string
    • Optional requestId: number

    Returns number

    • 0: Success.
    • < 0: Failure.
  • disables a lock

    Parameters

    • channelName: string
    • channelType: RTM_CHANNEL_TYPE
    • lockName: string
    • owner: string
    • Optional requestId: number

    Returns number

    • 0: Success.
    • < 0: Failure.
  • sets a lock

    Parameters

    • channelName: string
    • channelType: RTM_CHANNEL_TYPE
    • lockName: string
    • ttl: number
    • Optional requestId: number

    Returns number

    • 0: Success.
    • < 0: Failure.