Class OpenChannelModule

constructor

• new OpenChannelModule(): OpenChannelModule

• Returns OpenChannelModule

name

addOpenChannelHandler

• addOpenChannelHandler(key, handler): void

• Parameters

  • key: string
  • handler: OpenChannelHandler

  Returns void

  Description

  Adds a OpenChannelHandler with a key.

buildOpenChannelFromSerializedData

• buildOpenChannelFromSerializedData(serialized): OpenChannel

• Parameters

  • serialized: object

  Returns OpenChannel

  Description

  Creates an OpenChannel instance from serialized object. openChannel.serialize() returns the serialized object.

createChannel

• createChannel(params?): Promise<OpenChannel>

• Parameters

  • params: OpenChannelCreateParams = {}

  Returns Promise<OpenChannel>

  Creates an OpenChannel.

createChannelWithOperatorUserIds

• createChannelWithOperatorUserIds(name, coverUrlOrImageFile, data, operatorUserIds, customType): Promise<OpenChannel>

• Parameters

  • name: string
  • coverUrlOrImageFile: string | FileCompat
  • data: string
  • operatorUserIds: string[]
  • customType: string

  Returns Promise<OpenChannel>

  Creates an OpenChannel with given parameters.

  Deprecated

createOpenChannelListQuery

• createOpenChannelListQuery(params?): OpenChannelListQuery

• Parameters

  • params: OpenChannelListQueryParams = {}

  Returns OpenChannelListQuery

  Description

  Creates a OpenChannelListQuery.

getChannel

• getChannel(channelUrl): Promise<OpenChannel>

• Parameters

  • channelUrl: string

  Returns Promise<OpenChannel>

  Description

  Gets an OpenChannel with given channel URL.

getChannelWithoutCache

• getChannelWithoutCache(channelUrl): Promise<OpenChannel>

• Parameters

  • channelUrl: string

  Returns Promise<OpenChannel>

  Description

  Gets an OpenChannel with given channel URL from server.

removeAllOpenChannelHandlers

• removeAllOpenChannelHandlers(): void

• Returns void

  Description

  Removes all OpenChannelHandlers.

removeOpenChannelHandler

• removeOpenChannelHandler(key): void

• Parameters

  • key: string

  Returns void

  Description

  Removes a OpenChannelHandler for a key.