UserType Class Reference

Inherits from NSObject
Declared in RtccData.h

Overview

UserType is used to authenticate a user based on the provided data.

+ UserTypeExternalWithParentID:

Generate a UserType set for external authentication.

+ (instancetype)UserTypeExternalWithParentID:(NSString *)parentUID
Parameters
parentUID

The UID of the parent. The parent must be logged in when the external user is trying to log in.

Return Value

A UserType to be used in [Rtcc connectWithAppID:andUserType:]

Discussion

Generate a UserType set for external authentication.

Declared In

RtccData.h

+ UserTypeInternalWithToken:

Generate a UserType set for internal authentication.

+ (instancetype)UserTypeInternalWithToken:(NSString *)token
Parameters
token

The token generated to authenticate the user.

Return Value

A UserType to be used in [Rtcc connectWithAppID:andUserType:]

Discussion

Generate a UserType set for internal authentication.

Declared In

RtccData.h

+ UserTypeSixDigitsWithPIN:

Generate a UserType set for six digits authentication.

+ (instancetype)UserTypeSixDigitsWithPIN:(NSString *)sixDigits
Parameters
sixDigits

The sixdigit code generated by the parent.

Return Value

A UserType to be used in [Rtcc connectWithAppID:andUserType:]

Discussion

Generate a UserType set for six digits authentication.

Declared In

RtccData.h

+ UserTypeAttendeeWithUID:suffix:mpID:andUserhash:

Generate a UserType set for attendee authentication.

+ (instancetype)UserTypeAttendeeWithUID:(NSString *)uid suffix:(NSString *)suffix mpID:(NSString *)mpid andUserhash:(NSString *)userhash
Parameters
uid

This is the UID of the host.

suffix

This is the hash with which the system recognize an already authenticated user.

mpid

This is the ID of the Meeting Point.

userhash

This is the hash with which the system recognize an already authenticated user.

Return Value

A UserType to be used in [Rtcc connectWithAppID:andUserType:]

Discussion

Generate a UserType set for attendee authentication.

Declared In

RtccData.h

  currentProfile

This value is computed depending on the field sets.

If it turns to be invalid, authentication will not take place.

@property (nonatomic, readonly) userProfile_t currentProfile
Availability

5.5

Declared In

RtccData.h

  parentUID

External User. Set only this field.

This is the parent UID of the external user. The parent must be logged in when the external user is trying to log in.

@property (nonatomic) NSString *parentUID
Availability

5.5

Declared In

RtccData.h

  token

Internal User. Set only this field.

This is the token generated to authenticate the user.

@property (nonatomic) NSString *token
Availability

5.5

Declared In

RtccData.h

  sixDigits

SixDigits User. Set only this field.

This is the sixdigit code generated by the parent.

@property (nonatomic) NSString *sixDigits
Availability

5.5

Declared In

RtccData.h

  suffix

Attendee User. This is one of the four fields to set.

This is the suffix used by the system to recognized the user as attendee.

@property (nonatomic) NSString *suffix
Availability

5.5

Declared In

RtccData.h

  userHash

Attendee User. This is one of the four fields to set.

This is the hash with which the system recognize an already authenticated user.

@property (nonatomic) NSString *userHash
Availability

5.5

Declared In

RtccData.h

  uid

Attendee User. This is one of the four fields to set.

This is the UID of the host.

@property (nonatomic) NSString *uid
Availability

5.5

Declared In

RtccData.h

  mpid

Attendee User. This is one of the four fields to set.

This is the ID of the Meeting Point.

@property (nonatomic) NSString *mpid
Availability

5.5

Declared In

RtccData.h