HMSConfig

CLASS

 
@objcMembers public class HMSConfig: NSObject

To join a room created, clients need to create a HMSConfig instance and use that instance to call join method of HMSSDK

Properties

userName

 
public let userName: String

the name that the user wants to be displayed while in the room

userID

 
public let userID: String

roomID

 
public let roomID: String

authToken

 
public let authToken: String

the auth token to be used

shouldSkipPIIEvents

 
public let shouldSkipPIIEvents: Bool

metaData

 
public let metaData: String?

any json string or metadata that can be passed while joining

endpoint

 
public let endpoint: String?

to override the default endpoint (advanced)

Methods

init(userName:userID:roomID:authToken:shouldSkipPIIEvents:metaData:endpoint:)

 
public init(userName: String = "iOS User",
            userID: String,
            roomID: String,
            authToken: String,
            shouldSkipPIIEvents: Bool = false,
            metaData: String? = nil,
            endpoint: String? = nil)