IClientInfo interface

  • Reference
Package:
@microsoft/live-share

Returned from LiveShareHost.getClientInfo() to specify the user information for a given clientId. Each user individually requests this data for each other user in the session, making it secure & trusted.

Properties

displayName

Optional. The display name for the user.
roles

List of roles of the user.
userId

The user identifier that corresponds to the provided client identifier.

Property Details

displayName

Optional. The display name for the user.

displayName?: string

Property Value

string

roles

List of roles of the user.

roles: UserMeetingRole[]

Property Value

UserMeetingRole[]

userId

The user identifier that corresponds to the provided client identifier.

userId: string

Property Value

string