ChannelModerationRepository

ChannelModerationRepository

new ChannelModerationRepository()

Members

(readonly) channelId() :string

Get current channel ID
Type:
  • string

(readonly) privileges() :LiveObject

Get privileges
Type:

Methods

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

Set rate limit
Parameters:
Name Type Description
parameters Object
Properties
Name Type Description
rateLimit number The rate limit number.
rateLimitWindow number The rate limit window.
period number The rate limit period.
Throws:
Will throw an error if parameters are wrong.
Type
EkoSDKInvalidParameterError
Returns:
Returns a promise.
Type
Promise.<undefined, EkoSDKError>

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

Remove rate limit
Returns:
Returns a promise.
Type
Promise.<undefined, EkoSDKError>

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

Mute members
Parameters:
Name Type Description
parameters Object
Properties
Name Type Description
userIds Array.<string> The muted user ID.
period number The mute period.
Throws:
Will throw an error if parameters are wrong.
Type
EkoSDKInvalidParameterError
Returns:
Returns a promise.
Type
Promise.<undefined, EkoSDKError>

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

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

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

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

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

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

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

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

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

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