KiiUserBuilder Class Reference
| Inherits from | NSObject |
| Declared in | KiiUserBuilder.h |
Class Methods
builderWithEmail:password:
Create a KiiUser builder with an email address.
+ (instancetype)builderWithEmail:(NSString *)emailAddress password:(NSString *)passwordParameters
- emailAddress
email address for the user.
- password
for the user.
Return Value
KiiUser object builder.
Discussion
Create a KiiUser builder with an email address.
Declared In
KiiUserBuilder.hbuilderWithGlobalPhoneNumber:password:
Create a KiiUser builder with an global phone number.
+ (instancetype)builderWithGlobalPhoneNumber:(NSString *)phoneNumber password:(NSString *)passwordParameters
- phoneNumber
global phone number for the user.
- password
for the user.
Return Value
KiiUser object builder.
Discussion
Create a KiiUser builder with an global phone number.
Declared In
KiiUserBuilder.hbuilderWithIdentifier:password:
Create a KiiUser builder. This constructor is received identifier. The identifier is one of user name, email address or phone number. This constructor automatically identity What is identifier and build proper KiiUser object on build method.
+ (nullable instancetype)builderWithIdentifier:(NSString *)identifier password:(NSString *)passwordParameters
- identifier
The user’s user name, email address or phone number.
- password
for the user.
Return Value
KiiUser object builder. nil if identifier is none of email address, phone number and user name.
Discussion
Create a KiiUser builder. This constructor is received identifier. The identifier is one of user name, email address or phone number. This constructor automatically identity What is identifier and build proper KiiUser object on build method.
Some strings can be accepted as both user name and phone number. If such string is passed to this constructor as identifier, then phone number is prior to user name. String of email address is in different class against user name and phone number. So Email address is always identified correctly.
Declared In
KiiUserBuilder.hbuilderWithLocalPhoneNumber:country:password:
Create a KiiUser builder with an local phone number and country code.
+ (instancetype)builderWithLocalPhoneNumber:(NSString *)phoneNumber country:(NSString *)country password:(NSString *)passwordParameters
- phoneNumber
local phone number for the user.
- country
country code for the local phone number.
- password
for the user.
Return Value
KiiUser object builder.
Discussion
Create a KiiUser builder with an local phone number and country code.
Declared In
KiiUserBuilder.hbuilderWithUsername:password:
Create a KiiUser builder with an user name.
+ (instancetype)builderWithUsername:(NSString *)username password:(NSString *)passwordParameters
- username
user name.
- password
for the user.
Return Value
KiiUser object builder.
Discussion
Create a KiiUser builder with an user name.
Declared In
KiiUserBuilder.hInstance Methods
build
Build KiiUser object.
- (KiiUser *)buildReturn Value
a working KiiUser object.
Discussion
Build KiiUser object.
Build KiiUser object. This method verify set values.
Declared In
KiiUserBuilder.hsetEmail:
Set email address.
- (instancetype)setEmail:(nullable NSString *)emailAddressParameters
- emailAddress
email address.
Return Value
this builder object.
Discussion
Set email address.
Declared In
KiiUserBuilder.hsetGlobalPhoneNumber:
Set global phone number.
- (instancetype)setGlobalPhoneNumber:(nullable NSString *)phoneNumberParameters
- phoneNumber
phone number.
Return Value
this builder object.
Discussion
Set global phone number.
If local phone number and its country code is alreday set to this builder instance, this method makes country code null.
Declared In
KiiUserBuilder.hsetLocalPhoneNumber:country:
Set local phone number and its country code.
- (instancetype)setLocalPhoneNumber:(nullable NSString *)phoneNumber country:(nullable NSString *)countryParameters
- phoneNumber
local phone number
- country
country code.
Return Value
this builder object.
Discussion
Set local phone number and its country code.
If global phone number is alreday set to this builder instance, this method remove the global phone number.
Declared In
KiiUserBuilder.h