Represents a role within the HMS ecosystem.

A role defines the capabilities and permissions a user has in a session, such as publishing or subscribing to streams, and the priority of the user in the session. This class encapsulates the properties of a role, including its name, publishing settings, subscribing settings, permissions, and priority.

Hierarchy

  • HMSRole

Constructors

Properties

name?: string

The name of the role.

permissions?: HMSPermissions

Permissions granted to this role.

priority?: number

The priority of the role, determining its precedence in the session.

publishSettings?: HMSPublishSettings

Settings related to publishing streams for this role.

subscribeSettings?: HMSSubscribeSettings

Settings related to subscribing to streams for this role.

Generated using TypeDoc