FMLiveSwitchToken Class Reference

A token. More...

Instance Methods
(NSString *)	- algorithm
	Gets the algorithm. More...
(NSString *)	- apiServiceId
	Gets the API Service identifier. More...
(NSString *)	- applicationId
	Gets the application identifier. More...
(FMLiveSwitchChannelClaim *)	- channelClaim
	Gets the first channel claim. More...
(NSMutableArray *)	- channelClaims
	Gets an array of channel claims. More...
(NSString *)	- clientId
	Gets the client identifier. More...
(NSMutableArray *)	- clientRoles
	Gets the client roles. More...
(NSString *)	- connectorId
	Gets the Connector identifier. More...
(NSString *)	- deviceId
	Gets the device identifier. More...
(FMLiveSwitchNullableDate *)	- expirationTime
	Gets the "expires at" date/time. More...
(NSDate *)	- issuedAt
	Gets the "issued at" date/time. More...
(NSString *)	- mediaServerId
	Gets the Media Server identifier. More...
(NSString *)	- recordingMonitorId
	Gets the Recording Monitor identifier. More...
(NSString *)	- recordingMoverId
	Gets the Recording Mover identifier. More...
(NSString *)	- recordingMuxerId
	Gets the Recording Muxer identifier. More...
(NSString *)	- region
	Gets the region. More...
(NSString *)	- type
	Gets the type. More...
(NSString *)	- userId
	Gets the user identifier. More...
(bool)	- verifyWithSharedSecret:
	Verifies the token signature. More...
(NSString *)	- webSocketMediaServerId
	Gets the Web Socket Media Server identifier. More...

Class Methods
(int)	+ defaultExpiry
	Gets the default token expiry (120 seconds). More...
(NSString *)	+ generateClientJoinTokenWithApplicationId:userId:deviceId:clientId:channelClaim:sharedSecret:
	Generates a signed client join token. More...
(NSString *)	+ generateClientJoinTokenWithApplicationId:userId:deviceId:clientId:channelClaim:sharedSecret:expirationTime:
	Generates a signed client join token. More...
(NSString *)	+ generateClientJoinTokenWithApplicationId:userId:deviceId:clientId:channelId:sharedSecret:
	Generates a signed client join token. More...
(NSString *)	+ generateClientJoinTokenWithApplicationId:userId:deviceId:clientId:channelId:sharedSecret:expirationTime:
	Generates a signed client join token. More...
(NSString *)	+ generateClientJoinTokenWithClient:channelClaim:sharedSecret:
	Generates a signed client join token. More...
(NSString *)	+ generateClientJoinTokenWithClient:channelClaim:sharedSecret:expirationTime:
	Generates a signed client join token. More...
(NSString *)	+ generateClientJoinTokenWithClient:channelId:sharedSecret:
	Generates a signed client join token. More...
(NSString *)	+ generateClientJoinTokenWithClient:channelId:sharedSecret:expirationTime:
	Generates a signed client join token. More...
(NSString *)	+ generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:channelClaims:sharedSecret:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelClaims:sharedSecret:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelClaims:sharedSecret:expirationTime:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelClaims:sharedSecret:expirationTime:region:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelClaims:sharedSecret:region:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelId:sharedSecret:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelId:sharedSecret:expirationTime:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelId:sharedSecret:expirationTime:region:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelId:sharedSecret:region:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelIds:sharedSecret:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelIds:sharedSecret:expirationTime:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelIds:sharedSecret:expirationTime:region:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelIds:sharedSecret:region:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithClient:channelClaims:sharedSecret:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithClient:channelClaims:sharedSecret:expirationTime:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithClient:channelClaims:sharedSecret:expirationTime:region:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithClient:channelClaims:sharedSecret:region:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithClient:channelId:sharedSecret:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithClient:channelId:sharedSecret:expirationTime:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithClient:channelId:sharedSecret:expirationTime:region:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithClient:channelId:sharedSecret:region:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithClient:channelIds:sharedSecret:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithClient:channelIds:sharedSecret:expirationTime:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithClient:channelIds:sharedSecret:expirationTime:region:
	Generates a signed client register token. More...
(NSString *)	+ generateClientRegisterTokenWithClient:channelIds:sharedSecret:region:
	Generates a signed client register token. More...
(NSString *)	+ generateClientWebSocketAccessTokenWithApplicationId:userId:deviceId:clientId:sharedSecret:
	Generates a signed client websocket access token. More...
(NSString *)	+ generateEventTokenWithApplicationId:sharedSecret:
	Generates a signed event token. More...
(NSString *)	+ generateEventTokenWithApplicationId:sharedSecret:expirationTime:
	Generates a signed event token. More...
(NSString *)	+ hmacSha256Algorithm
	Gets the HMAC SHA-256 algorithm string. More...
(FMLiveSwitchToken *)	+ parseWithTokenString:
	Parses a token string. More...
(NSString *)	+ rsaSha256Algorithm
	Gets the RSA SHA-256 algorithm string. More...
(bool)	+ verifyWithTokenString:sharedSecret:
	Parses a token and verifies its signature. More...

Detailed Description

A token.

Method Documentation

algorithm

- (NSString*) algorithm

Gets the algorithm.

apiServiceId

- (NSString*) apiServiceId

Gets the API Service identifier.

applicationId

- (NSString*) applicationId

Gets the application identifier.

channelClaim

- (FMLiveSwitchChannelClaim*) channelClaim

Gets the first channel claim.

channelClaims

- (NSMutableArray*) channelClaims

Gets an array of channel claims.

clientId

- (NSString*) clientId

Gets the client identifier.

clientRoles

- (NSMutableArray*) clientRoles

Gets the client roles.

connectorId

- (NSString*) connectorId

Gets the Connector identifier.

defaultExpiry

+ (int) defaultExpiry

Gets the default token expiry (120 seconds).

deviceId

- (NSString*) deviceId

Gets the device identifier.

expirationTime

- (FMLiveSwitchNullableDate*) expirationTime

Gets the "expires at" date/time.

generateClientJoinTokenWithApplicationId:userId:deviceId:clientId:channelClaim:sharedSecret:

+ (NSString*) generateClientJoinTokenWithApplicationId:		(NSString *)	applicationId
userId:		(NSString *)	userId
deviceId:		(NSString *)	deviceId
clientId:		(NSString *)	clientId
channelClaim:		(FMLiveSwitchChannelClaim *)	channelClaim
sharedSecret:		(NSString *)	sharedSecret

Generates a signed client join token.

Parameters

applicationId	The application identifier.
userId	The user identifier.
deviceId	The device identifier.
clientId	The client identifier.
channelClaim	The channel claim.
sharedSecret	The shared secret.

generateClientJoinTokenWithApplicationId:userId:deviceId:clientId:channelClaim:sharedSecret:expirationTime:

+ (NSString*) generateClientJoinTokenWithApplicationId:		(NSString *)	applicationId
userId:		(NSString *)	userId
deviceId:		(NSString *)	deviceId
clientId:		(NSString *)	clientId
channelClaim:		(FMLiveSwitchChannelClaim *)	channelClaim
sharedSecret:		(NSString *)	sharedSecret
expirationTime:		(NSDate *)	expirationTime

Generates a signed client join token.

Parameters

applicationId	The application identifier.
userId	The user identifier.
deviceId	The device identifier.
clientId	The client identifier.
channelClaim	The channel claim.
sharedSecret	The shared secret.
expirationTime	The time the token will expire in UTC.

generateClientJoinTokenWithApplicationId:userId:deviceId:clientId:channelId:sharedSecret:

+ (NSString*) generateClientJoinTokenWithApplicationId:		(NSString *)	applicationId
userId:		(NSString *)	userId
deviceId:		(NSString *)	deviceId
clientId:		(NSString *)	clientId
channelId:		(NSString *)	channelId
sharedSecret:		(NSString *)	sharedSecret

Generates a signed client join token.

Parameters

applicationId	The application identifier.
userId	The user identifier.
deviceId	The device identifier.
clientId	The client identifier.
channelId	The channel identifier.
sharedSecret	The shared secret.

generateClientJoinTokenWithApplicationId:userId:deviceId:clientId:channelId:sharedSecret:expirationTime:

+ (NSString*) generateClientJoinTokenWithApplicationId:		(NSString *)	applicationId
userId:		(NSString *)	userId
deviceId:		(NSString *)	deviceId
clientId:		(NSString *)	clientId
channelId:		(NSString *)	channelId
sharedSecret:		(NSString *)	sharedSecret
expirationTime:		(NSDate *)	expirationTime

Generates a signed client join token.

Parameters

applicationId	The application identifier.
userId	The user identifier.
deviceId	The device identifier.
clientId	The client identifier.
channelId	The channel identifier.
sharedSecret	The shared secret.
expirationTime	The time the token will expire in UTC.

generateClientJoinTokenWithClient:channelClaim:sharedSecret:

+ (NSString*) generateClientJoinTokenWithClient:		(FMLiveSwitchClient *)	client
channelClaim:		(FMLiveSwitchChannelClaim *)	channelClaim
sharedSecret:		(NSString *)	sharedSecret

Generates a signed client join token.

Parameters

client	The client.
channelClaim	The channel claim.
sharedSecret	The shared secret.

generateClientJoinTokenWithClient:channelClaim:sharedSecret:expirationTime:

+ (NSString*) generateClientJoinTokenWithClient:		(FMLiveSwitchClient *)	client
channelClaim:		(FMLiveSwitchChannelClaim *)	channelClaim
sharedSecret:		(NSString *)	sharedSecret
expirationTime:		(NSDate *)	expirationTime

Generates a signed client join token.

Parameters

client	The client.
channelClaim	The channel claim.
sharedSecret	The shared secret.
expirationTime	The time the token will expire in UTC.

generateClientJoinTokenWithClient:channelId:sharedSecret:

+ (NSString*) generateClientJoinTokenWithClient:		(FMLiveSwitchClient *)	client
channelId:		(NSString *)	channelId
sharedSecret:		(NSString *)	sharedSecret

Generates a signed client join token.

Parameters

client	The client.
channelId	The channel identifier.
sharedSecret	The shared secret.

generateClientJoinTokenWithClient:channelId:sharedSecret:expirationTime:

+ (NSString*) generateClientJoinTokenWithClient:		(FMLiveSwitchClient *)	client
channelId:		(NSString *)	channelId
sharedSecret:		(NSString *)	sharedSecret
expirationTime:		(NSDate *)	expirationTime

Generates a signed client join token.

Parameters

client	The client.
channelId	The channel identifier.
sharedSecret	The shared secret.
expirationTime	The time the token will expire in UTC.

generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:channelClaims:sharedSecret:

+ (NSString*) generateClientRegisterTokenWithApplicationId:		(NSString *)	applicationId
userId:		(NSString *)	userId
deviceId:		(NSString *)	deviceId
clientId:		(NSString *)	clientId
channelClaims:		(NSMutableArray *)	channelClaims
sharedSecret:		(NSString *)	sharedSecret

Generates a signed client register token.

Parameters

applicationId	The application identifier.
userId	The user identifier.
deviceId	The device identifier.
clientId	The client identifier.
channelClaims	The channel claims.
sharedSecret	The shared secret.

generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelClaims:sharedSecret:

+ (NSString*) generateClientRegisterTokenWithApplicationId:		(NSString *)	applicationId
userId:		(NSString *)	userId
deviceId:		(NSString *)	deviceId
clientId:		(NSString *)	clientId
clientRoles:		(NSMutableArray *)	clientRoles
channelClaims:		(NSMutableArray *)	channelClaims
sharedSecret:		(NSString *)	sharedSecret

Generates a signed client register token.

Parameters

applicationId	The application identifier.
userId	The user identifier.
deviceId	The device identifier.
clientId	The client identifier.
clientRoles	The client roles.
channelClaims	The channel claims.
sharedSecret	The shared secret.

generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelClaims:sharedSecret:expirationTime:

+ (NSString*) generateClientRegisterTokenWithApplicationId:		(NSString *)	applicationId
userId:		(NSString *)	userId
deviceId:		(NSString *)	deviceId
clientId:		(NSString *)	clientId
clientRoles:		(NSMutableArray *)	clientRoles
channelClaims:		(NSMutableArray *)	channelClaims
sharedSecret:		(NSString *)	sharedSecret
expirationTime:		(NSDate *)	expirationTime

Generates a signed client register token.

Parameters

applicationId	The application identifier.
userId	The user identifier.
deviceId	The device identifier.
clientId	The client identifier.
clientRoles	The client roles.
channelClaims	The channel claims.
sharedSecret	The shared secret.
expirationTime	The time the token will expire in UTC.

generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelClaims:sharedSecret:expirationTime:region:

+ (NSString*) generateClientRegisterTokenWithApplicationId:		(NSString *)	applicationId
userId:		(NSString *)	userId
deviceId:		(NSString *)	deviceId
clientId:		(NSString *)	clientId
clientRoles:		(NSMutableArray *)	clientRoles
channelClaims:		(NSMutableArray *)	channelClaims
sharedSecret:		(NSString *)	sharedSecret
expirationTime:		(NSDate *)	expirationTime
region:		(NSString *)	region

Generates a signed client register token.

Parameters

applicationId	The application identifier.
userId	The user identifier.
deviceId	The device identifier.
clientId	The client identifier.
clientRoles	The client roles.
channelClaims	The channel claims.
sharedSecret	The shared secret.
expirationTime	The time the token will expire in UTC.
region	The region of the client.

generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelClaims:sharedSecret:region:

+ (NSString*) generateClientRegisterTokenWithApplicationId:		(NSString *)	applicationId
userId:		(NSString *)	userId
deviceId:		(NSString *)	deviceId
clientId:		(NSString *)	clientId
clientRoles:		(NSMutableArray *)	clientRoles
channelClaims:		(NSMutableArray *)	channelClaims
sharedSecret:		(NSString *)	sharedSecret
region:		(NSString *)	region

Generates a signed client register token.

Parameters

applicationId	The application identifier.
userId	The user identifier.
deviceId	The device identifier.
clientId	The client identifier.
clientRoles	The client roles.
channelClaims	The channel claims.
sharedSecret	The shared secret.
region	The region of the client.

generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelId:sharedSecret:

+ (NSString*) generateClientRegisterTokenWithApplicationId:		(NSString *)	applicationId
userId:		(NSString *)	userId
deviceId:		(NSString *)	deviceId
clientId:		(NSString *)	clientId
clientRoles:		(NSMutableArray *)	clientRoles
channelId:		(NSString *)	channelId
sharedSecret:		(NSString *)	sharedSecret

Generates a signed client register token.

Parameters

applicationId	The application identifier.
userId	The user identifier.
deviceId	The device identifier.
clientId	The client identifier.
clientRoles	The client roles.
channelId	The channel identifier.
sharedSecret	The shared secret.

generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelId:sharedSecret:expirationTime:

+ (NSString*) generateClientRegisterTokenWithApplicationId:		(NSString *)	applicationId
userId:		(NSString *)	userId
deviceId:		(NSString *)	deviceId
clientId:		(NSString *)	clientId
clientRoles:		(NSMutableArray *)	clientRoles
channelId:		(NSString *)	channelId
sharedSecret:		(NSString *)	sharedSecret
expirationTime:		(NSDate *)	expirationTime

Generates a signed client register token.

Parameters

applicationId	The application identifier.
userId	The user identifier.
deviceId	The device identifier.
clientId	The client identifier.
clientRoles	The client roles.
channelId	The channel identifier.
sharedSecret	The shared secret.
expirationTime	The time the token will expire in UTC.

generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelId:sharedSecret:expirationTime:region:

+ (NSString*) generateClientRegisterTokenWithApplicationId:		(NSString *)	applicationId
userId:		(NSString *)	userId
deviceId:		(NSString *)	deviceId
clientId:		(NSString *)	clientId
clientRoles:		(NSMutableArray *)	clientRoles
channelId:		(NSString *)	channelId
sharedSecret:		(NSString *)	sharedSecret
expirationTime:		(NSDate *)	expirationTime
region:		(NSString *)	region

Generates a signed client register token.

Parameters

applicationId	The application identifier.
userId	The user identifier.
deviceId	The device identifier.
clientId	The client identifier.
clientRoles	The client roles.
channelId	The channel identifier.
sharedSecret	The shared secret.
expirationTime	The time the token will expire in UTC.
region	The region of the client.

generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelId:sharedSecret:region:

+ (NSString*) generateClientRegisterTokenWithApplicationId:		(NSString *)	applicationId
userId:		(NSString *)	userId
deviceId:		(NSString *)	deviceId
clientId:		(NSString *)	clientId
clientRoles:		(NSMutableArray *)	clientRoles
channelId:		(NSString *)	channelId
sharedSecret:		(NSString *)	sharedSecret
region:		(NSString *)	region

Generates a signed client register token.

Parameters

applicationId	The application identifier.
userId	The user identifier.
deviceId	The device identifier.
clientId	The client identifier.
clientRoles	The client roles.
channelId	The channel identifier.
sharedSecret	The shared secret.
region	The region of the client.

generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelIds:sharedSecret:

+ (NSString*) generateClientRegisterTokenWithApplicationId:		(NSString *)	applicationId
userId:		(NSString *)	userId
deviceId:		(NSString *)	deviceId
clientId:		(NSString *)	clientId
clientRoles:		(NSMutableArray *)	clientRoles
channelIds:		(NSMutableArray *)	channelIds
sharedSecret:		(NSString *)	sharedSecret

Generates a signed client register token.

Parameters

applicationId	The application identifier.
userId	The user identifier.
deviceId	The device identifier.
clientId	The client identifier.
clientRoles	The client roles.
channelIds	The channel identifiers.
sharedSecret	The shared secret.

generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelIds:sharedSecret:expirationTime:

+ (NSString*) generateClientRegisterTokenWithApplicationId:		(NSString *)	applicationId
userId:		(NSString *)	userId
deviceId:		(NSString *)	deviceId
clientId:		(NSString *)	clientId
clientRoles:		(NSMutableArray *)	clientRoles
channelIds:		(NSMutableArray *)	channelIds
sharedSecret:		(NSString *)	sharedSecret
expirationTime:		(NSDate *)	expirationTime

Generates a signed client register token.

Parameters

applicationId	The application identifier.
userId	The user identifier.
deviceId	The device identifier.
clientId	The client identifier.
clientRoles	The client roles.
channelIds	The channel identifiers.
sharedSecret	The shared secret.
expirationTime	The time the token will expire in UTC.

generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelIds:sharedSecret:expirationTime:region:

+ (NSString*) generateClientRegisterTokenWithApplicationId:		(NSString *)	applicationId
userId:		(NSString *)	userId
deviceId:		(NSString *)	deviceId
clientId:		(NSString *)	clientId
clientRoles:		(NSMutableArray *)	clientRoles
channelIds:		(NSMutableArray *)	channelIds
sharedSecret:		(NSString *)	sharedSecret
expirationTime:		(NSDate *)	expirationTime
region:		(NSString *)	region

Generates a signed client register token.

Parameters

applicationId	The application identifier.
userId	The user identifier.
deviceId	The device identifier.
clientId	The client identifier.
clientRoles	The client roles.
channelIds	The channel identifiers.
sharedSecret	The shared secret.
expirationTime	The time the token will expire in UTC.
region	The region of the client.

generateClientRegisterTokenWithApplicationId:userId:deviceId:clientId:clientRoles:channelIds:sharedSecret:region:

+ (NSString*) generateClientRegisterTokenWithApplicationId:		(NSString *)	applicationId
userId:		(NSString *)	userId
deviceId:		(NSString *)	deviceId
clientId:		(NSString *)	clientId
clientRoles:		(NSMutableArray *)	clientRoles
channelIds:		(NSMutableArray *)	channelIds
sharedSecret:		(NSString *)	sharedSecret
region:		(NSString *)	region

Generates a signed client register token.

Parameters

applicationId	The application identifier.
userId	The user identifier.
deviceId	The device identifier.
clientId	The client identifier.
clientRoles	The client roles.
channelIds	The channel identifiers.
sharedSecret	The shared secret.
region	The region of the client.

generateClientRegisterTokenWithClient:channelClaims:sharedSecret:

+ (NSString*) generateClientRegisterTokenWithClient:		(FMLiveSwitchClient *)	client
channelClaims:		(NSMutableArray *)	channelClaims
sharedSecret:		(NSString *)	sharedSecret

Generates a signed client register token.

Parameters

client	The client.
channelClaims	The channel claims.
sharedSecret	The shared secret.

generateClientRegisterTokenWithClient:channelClaims:sharedSecret:expirationTime:

+ (NSString*) generateClientRegisterTokenWithClient:		(FMLiveSwitchClient *)	client
channelClaims:		(NSMutableArray *)	channelClaims
sharedSecret:		(NSString *)	sharedSecret
expirationTime:		(NSDate *)	expirationTime

Generates a signed client register token.

Parameters

client	The client.
channelClaims	The channel claims.
sharedSecret	The shared secret.
expirationTime	The time the token will expire in UTC.

generateClientRegisterTokenWithClient:channelClaims:sharedSecret:expirationTime:region:

+ (NSString*) generateClientRegisterTokenWithClient:		(FMLiveSwitchClient *)	client
channelClaims:		(NSMutableArray *)	channelClaims
sharedSecret:		(NSString *)	sharedSecret
expirationTime:		(NSDate *)	expirationTime
region:		(NSString *)	region

Generates a signed client register token.

Parameters

client	The client.
channelClaims	The channel claims.
sharedSecret	The shared secret.
expirationTime	The time the token will expire in UTC.
region	The region of the client.

generateClientRegisterTokenWithClient:channelClaims:sharedSecret:region:

+ (NSString*) generateClientRegisterTokenWithClient:		(FMLiveSwitchClient *)	client
channelClaims:		(NSMutableArray *)	channelClaims
sharedSecret:		(NSString *)	sharedSecret
region:		(NSString *)	region

Generates a signed client register token.

Parameters

client	The client.
channelClaims	The channel claims.
sharedSecret	The shared secret.
region	The region of the client.

generateClientRegisterTokenWithClient:channelId:sharedSecret:

+ (NSString*) generateClientRegisterTokenWithClient:		(FMLiveSwitchClient *)	client
channelId:		(NSString *)	channelId
sharedSecret:		(NSString *)	sharedSecret

Generates a signed client register token.

Parameters

client	The client.
channelId	The channel identifier.
sharedSecret	The shared secret.

generateClientRegisterTokenWithClient:channelId:sharedSecret:expirationTime:

+ (NSString*) generateClientRegisterTokenWithClient:		(FMLiveSwitchClient *)	client
channelId:		(NSString *)	channelId
sharedSecret:		(NSString *)	sharedSecret
expirationTime:		(NSDate *)	expirationTime

Generates a signed client register token.

Parameters

client	The client.
channelId	The channel identifier.
sharedSecret	The shared secret.
expirationTime	The time the token will expire in UTC.

generateClientRegisterTokenWithClient:channelId:sharedSecret:expirationTime:region:

+ (NSString*) generateClientRegisterTokenWithClient:		(FMLiveSwitchClient *)	client
channelId:		(NSString *)	channelId
sharedSecret:		(NSString *)	sharedSecret
expirationTime:		(NSDate *)	expirationTime
region:		(NSString *)	region

Generates a signed client register token.

Parameters

client	The client.
channelId	The channel identifier.
sharedSecret	The shared secret.
expirationTime	The time the token will expire in UTC.
region	The region of the client.

generateClientRegisterTokenWithClient:channelId:sharedSecret:region:

+ (NSString*) generateClientRegisterTokenWithClient:		(FMLiveSwitchClient *)	client
channelId:		(NSString *)	channelId
sharedSecret:		(NSString *)	sharedSecret
region:		(NSString *)	region

Generates a signed client register token.

Parameters

client	The client.
channelId	The channel identifier.
sharedSecret	The shared secret.
region	The region of the client.

generateClientRegisterTokenWithClient:channelIds:sharedSecret:

+ (NSString*) generateClientRegisterTokenWithClient:		(FMLiveSwitchClient *)	client
channelIds:		(NSMutableArray *)	channelIds
sharedSecret:		(NSString *)	sharedSecret

Generates a signed client register token.

Parameters

client	The client.
channelIds	The channel identifiers.
sharedSecret	The shared secret.

generateClientRegisterTokenWithClient:channelIds:sharedSecret:expirationTime:

+ (NSString*) generateClientRegisterTokenWithClient:		(FMLiveSwitchClient *)	client
channelIds:		(NSMutableArray *)	channelIds
sharedSecret:		(NSString *)	sharedSecret
expirationTime:		(NSDate *)	expirationTime

Generates a signed client register token.

Parameters

client	The client.
channelIds	The channel identifiers.
sharedSecret	The shared secret.
expirationTime	The time the token will expire in UTC.

generateClientRegisterTokenWithClient:channelIds:sharedSecret:expirationTime:region:

+ (NSString*) generateClientRegisterTokenWithClient:		(FMLiveSwitchClient *)	client
channelIds:		(NSMutableArray *)	channelIds
sharedSecret:		(NSString *)	sharedSecret
expirationTime:		(NSDate *)	expirationTime
region:		(NSString *)	region

Generates a signed client register token.

Parameters

client	The client.
channelIds	The channel identifiers.
sharedSecret	The shared secret.
expirationTime	The time the token will expire in UTC.
region	The region of the client.

generateClientRegisterTokenWithClient:channelIds:sharedSecret:region:

+ (NSString*) generateClientRegisterTokenWithClient:		(FMLiveSwitchClient *)	client
channelIds:		(NSMutableArray *)	channelIds
sharedSecret:		(NSString *)	sharedSecret
region:		(NSString *)	region

Generates a signed client register token.

Parameters

client	The client.
channelIds	The channel identifiers.
sharedSecret	The shared secret.
region	The region of the client.

generateClientWebSocketAccessTokenWithApplicationId:userId:deviceId:clientId:sharedSecret:

+ (NSString*) generateClientWebSocketAccessTokenWithApplicationId:		(NSString *)	applicationId
userId:		(NSString *)	userId
deviceId:		(NSString *)	deviceId
clientId:		(NSString *)	clientId
sharedSecret:		(NSString *)	sharedSecret

Generates a signed client websocket access token.

Parameters

applicationId
userId
deviceId
clientId
sharedSecret

generateEventTokenWithApplicationId:sharedSecret:

+ (NSString*) generateEventTokenWithApplicationId:		(NSString *)	applicationId
sharedSecret:		(NSString *)	sharedSecret

Generates a signed event token.

Parameters

applicationId	The application identifier.
sharedSecret	The shared secret.

generateEventTokenWithApplicationId:sharedSecret:expirationTime:

+ (NSString*) generateEventTokenWithApplicationId:		(NSString *)	applicationId
sharedSecret:		(NSString *)	sharedSecret
expirationTime:		(NSDate *)	expirationTime

Generates a signed event token.

Parameters

applicationId	The application identifier.
sharedSecret	The shared secret.
expirationTime	The expiration time.

hmacSha256Algorithm

+ (NSString*) hmacSha256Algorithm

Gets the HMAC SHA-256 algorithm string.

issuedAt

- (NSDate*) issuedAt

Gets the "issued at" date/time.

mediaServerId

- (NSString*) mediaServerId

Gets the Media Server identifier.

parseWithTokenString:

+ (FMLiveSwitchToken*) parseWithTokenString:

(NSString *)

tokenString

Parses a token string.

Parameters

tokenString

The token string.

Returns

The token.

recordingMonitorId

- (NSString*) recordingMonitorId

Gets the Recording Monitor identifier.

recordingMoverId

- (NSString*) recordingMoverId

Gets the Recording Mover identifier.

recordingMuxerId

- (NSString*) recordingMuxerId

Gets the Recording Muxer identifier.

region

- (NSString*) region

Gets the region.

rsaSha256Algorithm

+ (NSString*) rsaSha256Algorithm

Gets the RSA SHA-256 algorithm string.

type

- (NSString*) type

Gets the type.

userId

- (NSString*) userId

Gets the user identifier.

verifyWithSharedSecret:

- (bool) verifyWithSharedSecret:

(NSString *)

sharedSecret

Verifies the token signature.

Parameters

sharedSecret

The shared secret.

Returns

true if the signature is valid; otherwise, false.

verifyWithTokenString:sharedSecret:

+ (bool) verifyWithTokenString:		(NSString *)	tokenString
sharedSecret:		(NSString *)	sharedSecret

Parses a token and verifies its signature.

Parameters

tokenString	The token string.
sharedSecret	The shared secret.

Returns

true if the token string could be parsed and the signature is valid; otherwise, false

webSocketMediaServerId

- (NSString*) webSocketMediaServerId

Gets the Web Socket Media Server identifier.