Options
All
  • Public
  • Public/Protected
  • All
Menu

API definition for cloud sessions

Note: SessionInterface is used for local sessions, while CloudSessionInterface is used for remote sessions. The cloud session must be activated before use.

Hierarchy

  • CloudSessionInterface

Implemented by

Index

Methods

  • deleteServerSessions(options: { sessions: { scene: "p2p" | "team" | "superTeam"; to: string }[]; done: any }): void
  • getServerSession(options: { scene: "p2p" | "team" | "superTeam"; to: string; done: any }): void
  • getServerSessions(options: { limit?: number; maxTimestamp?: number; minTimestamp?: number; needLastMsg?: boolean; done: any }): void
  • Get the server sessions

    Parameters

    • options: { limit?: number; maxTimestamp?: number; minTimestamp?: number; needLastMsg?: boolean; done: any }
      • Optional limit?: number

        Pagination size. 100 by default

      • Optional maxTimestamp?: number

        The maximum timestamp, paired with minTimestamp for a search condition.。

        The current timestamp is used by default.

      • Optional minTimestamp?: number

        The minimum timestamp, paired with maxTimestamp for a search condition.。

        The default value 0 indicates no limit

      • Optional needLastMsg?: boolean

        Whether the last msg is returned, true by default.

      • done:function

    Returns void

  • updateServerSession(options: { extra: string; scene: "p2p" | "team" | "superTeam"; to: string; done: any }): void
  • Parameters

    • options: { extra: string; scene: "p2p" | "team" | "superTeam"; to: string; done: any }

    Returns void