ChannelMembershipRepository

ChannelMembershipRepository

new ChannelMembershipRepository()

Members

(readonly) channelId :String

Get channel ID
Type:
  • String

(readonly) myMembership() :LiveObject

Get user channel membership. Returns a LiveObject instance of MemberModel.
Type:

Methods

members() → {LiveCollection}

Get all members in channel.
Returns:
The LiveCollection instance of member models.
Type
LiveCollection

membersForFilter(parameters) → {LiveCollection}

Get all members for filter.
Parameters:
Name Type Description
parameters Object
Properties
Name Type Attributes Description
filterType EkoMemberFilter The filterType to filter members with.
role string <optional>
 The Role to filter members with.
Throws:
Will throw an error if parameters are wrong.
Type
EkoSDKInvalidParameterError
Returns:
The LiveCollection instance of member models.
Type
LiveCollection

leave() → {Promise.<undefined, EkoSDKError>}

Leave channel membership
Returns:
Returns a promise.
Type
Promise.<undefined, EkoSDKError>

addMembers(parameters) → {Promise.<undefined, EkoSDKError>}

Add members.
Parameters:
Name Type Description
parameters Object
Properties
Name Type Description
userIds Array.<string> The user IDs of added members.
Throws:
Will throw an error if parameters are wrong.
Type
EkoSDKInvalidParameterError
Returns:
Returns a promise.
Type
Promise.<undefined, EkoSDKError>

removeMembers(parameters) → {Promise.<undefined, EkoSDKError>}

Remove members.
Parameters:
Name Type Description
parameters Object
Properties
Name Type Description
userIds Array.<string> The user IDs of removed members.
Throws:
Will throw an error if parameters are wrong.
Type
EkoSDKInvalidParameterError
Returns:
Returns a promise.
Type
Promise.<undefined, EkoSDKError>

startReading() → {Promise.<undefined, EkoSDKError>}

Start reading channel data
Returns:
Returns a promise.
Type
Promise.<undefined, EkoSDKError>

stopReading() → {Promise.<undefined, EkoSDKError>}

Stop reading channel data
Returns:
Returns a promise.
Type
Promise.<undefined, EkoSDKError>