KiiUser Class

AccessToken Property

Gets the access token.

Syntax

public static string AccessToken { get; }

Value

The access token.

Remarks

If user is not logged in, return null.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Bucket Method

Returns bucket belongs to this user.

Syntax

public KiiBucket Bucket (string bucketName)

Parameters

bucketName

Bucket name.

Returns

User scope KiiBucket instance.

Exceptions

Type	Reason
ArgumentException	Is throwns when bucket name is invalid.

Remarks

Returns bucket belongs to this user.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

BuilderWithEmail Method

Create Builder with email.

Syntax

public static KiiUser.Builder BuilderWithEmail (string email)

Parameters

email

Email.

Returns

KiiUser builder instance.

Exceptions

Type	Reason
ArgumentException	Email is not valid

Remarks

Email must be valid. See KiiUser.IsValidEmail(string)

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

BuilderWithIdentifier Method

Create Builder with identifier.

Syntax

public static KiiUser.Builder BuilderWithIdentifier (string identifier)

Parameters

identifier

The user's user name, email address or phone number.

Returns

Documentation for this section has not yet been entered.

Exceptions

Type	Reason
ArgumentException	Identifier is not user name, email address or phone number.

Remarks

This factory method receives identifier. The identifier is one of use name, email address or phone number. This constructor automatically identities what identifier is.

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.

This method accepts local phone number as identifier but if You use local phone number as identifier, You need to set country code to KiiUser instance built by KiiCorp.Cloud.Storage.KiiUser.Builder.Build.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

BuilderWithLocalPhone Method

Create Builder with local phone.

Syntax

public static KiiUser.Builder BuilderWithLocalPhone (string phone, string country)

Parameters

phone

Local phone.

country

Country.

Returns

KiiUser builder instance.

Exceptions

Type	Reason
ArgumentException	One of phone and country is not valid or both of phone and country are not valid.

Remarks

Phone and country must be valid. For phone, See KiiUser.IsValidLocalPhone(string). For country, See KiiUser.IsValidCountry(string).

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

BuilderWithName Method

Create Builder with user name.

Syntax

public static KiiUser.Builder BuilderWithName (string userName)

Parameters

userName

Username.

Returns

KiiUser builder instance.

Exceptions

Type	Reason
ArgumentException	Username is not valid

Remarks

Username must be valid. See KiiUser.IsValidUserName(string)

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

BuilderWithPhone Method

Create Builder with phone.

Syntax

public static KiiUser.Builder BuilderWithPhone (string phone)

Parameters

phone

Phone.

Returns

KiiUser builder instance.

Exceptions

Type	Reason
ArgumentException	Phone is not valid

Remarks

Phone must be valid. See KiiUser.IsValidPhone(string)

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

ChangeEmail Method

Change email of logged in user. If the email address verification is required by your app configuration, User's email would not changed to new one until the new email verification has been done. In this case, new mail address can be obtained by KiiUser.PendingEmail. This API does not refresh the KiiUser automatically. Please execute KiiUser.Refresh before checking the value of KiiUser.Email or KiiUser.PendingEmail

Syntax

[System.Obsolete("ChangeEmail(string) is deprecated, please use Update(IdentityData, CustomFields) instead", false)]
public static void ChangeEmail (string email)

Parameters

email

New email.

Exceptions

Type	Reason
ArgumentException	Is thrown when an argument is invalid.
KiiCorp.Cloud.Storage.CloudException	Is thrown when server sends error response.

Remarks

Email must be valid

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

ChangeEmail Method

Changes the email of CurrentUser

Syntax

[System.Obsolete("ChangeEmail(string, KiiCallback) is deprecated, please use Update(IdentityData, CustomFields, KiiUserCallback) instead", false)]
public static void ChangeEmail (string email, KiiCallback callback)

Parameters

email

New email.

callback

Callback.

Remarks

Email must be valid

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

ChangePassword Method

Changes the password of CurrentUser.

Syntax

public static void ChangePassword (string newPassword, string oldPassword)

Parameters

newPassword

New password.

oldPassword

Old password.

Exceptions

Type	Reason
ArgumentException	Is thrown when password is invalid.
InvalidOperationException	Is thrown when this user is not CurrentUser.
KiiCorp.Cloud.Storage.CloudException	Is thrown when server sends error response.

Remarks

NewPassword must be valid.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

ChangePassword Method

Changes the password of CurrentUser.

Syntax

public static void ChangePassword (string newPassword, string oldPassword, KiiCallback callback)

Parameters

newPassword

New password.

oldPassword

Old password.

callback

Callback.

Remarks

NewPassword must be valid.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

ChangePhone Method

Change phone number of logged in user. If the phone number verification is required by your app configuration, User's phone number would not changed to new one until the new phone number verification has been done. In this case, new phone can be obtained by KiiUser.PendingPhone This API does not refresh the KiiUser automatically. Please execute KiiUser.Refresh before checking the value of KiiUser.Phone or KiiUser.PendingPhone

Syntax

[System.Obsolete("ChangePhone(string) is deprecated, please use Update(IdentityData, CustomFields) instead", false)]
public static void ChangePhone (string phoneNumber)

Parameters

phoneNumber

New phone number.

Exceptions

Type	Reason
ArgumentException	Is thrown when an argument is null or invalid.
KiiCorp.Cloud.Storage.CloudException	Is thrown when server sends error response.

Remarks

Phone number must be valid.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

ChangePhone Method

Changes the phone number of CurrentUser.

Syntax

[System.Obsolete("ChangePhone(string, KiiCallback) is deprecated, please use Update(IdentityData, CustomFields, KiiUserCallback) instead", false)]
public static void ChangePhone (string phoneNumber, KiiCallback callback)

Parameters

phoneNumber

New phone number.

callback

Callback.

Remarks

Phone number must be valid.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

CompleteResetPassword Method

Reset password with the PIN code in receipt SMS. After KiiUser.ResetPassword(string, KiiCorp.Cloud.Storage.KiiUser.NotificationMethod) is called with KiiCorp.Cloud.Storage.KiiUser.NotificationMethod.SMS_PIN, SMS include the PIN code will be sent to the user's phone. User can set a new password for login with the PIN code. Need to call KiiUser.LogIn(string, string) to login after the new password is determined.

Syntax

public static void CompleteResetPassword (string identifier, string pinCode, string newPassword)

Parameters

identifier

should be valid email address, global phone number or user identifier obtained by KiiUser.ID.

pinCode

Received PIN code.

newPassword

New password for login. If the 'Password Reset Flow' in app's security setting is set to 'Generate password', it would be ignored and null can be passed. In this case, new password is generated on Kii Cloud and sent to user's phone. Otherwise valid password is required.

Exceptions

Type	Reason
KiiCorp.Cloud.Storage.BadRequestException	Is thrown when newPassword is invalid.
KiiCorp.Cloud.Storage.ForbiddenException	Is thrown when PIN code doesn’t match with sent via SMS.
KiiCorp.Cloud.Storage.ConflictException	Is thrown when the user does not have a verified phone number.
KiiCorp.Cloud.Storage.GoneException	Is thrown when PIN code to reset password has expired

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

CompleteResetPassword Method

Reset password with the PIN code in receipt SMS. After KiiUser.ResetPassword(string, KiiCorp.Cloud.Storage.KiiUser.NotificationMethod) is called with KiiCorp.Cloud.Storage.KiiUser.NotificationMethod.SMS_PIN, SMS include the PIN code will be sent to the user's phone. User can set a new password for login with the PIN code. Need to call KiiUser.LogIn(string, string) to login after the new password is determined.

Syntax

public static void CompleteResetPassword (string identifier, string pinCode, string newPassword, KiiCallback callback)

Parameters

identifier

should be valid email address, global phone number or user identifier obtained by KiiUser.ID.

pinCode

Received PIN code.

newPassword

New password for login. If the 'Password Reset Flow' in app's security setting is set to 'Generate password', it would be ignored and null can be passed. In this case, new password is generated on Kii Cloud and sent to user's phone. Otherwise valid password is required.

callback

Callback.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Country Property

Gets or sets the country.

Syntax

public string Country { get; set; }

Value

The country.

Exceptions

Type	Reason
ArgumentException	Is thrown when an argument is invalid.

Remarks

Country must be valid.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

CreateByUri Method

Creates KiiUser instance by URI.

Syntax

public static KiiUser CreateByUri (Uri uri)

Parameters

uri

User's URI.

Returns

KiiUser instance.

Exceptions

Type	Reason
ArgumentException	Is thrown when an argument is invalid.

Remarks

URI format is kiiuser:

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

CurrentUser Property

Gets the current user.

Syntax

public static KiiUser CurrentUser { get; }

Value

The current user.

Remarks

Current user is set when login is done.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Delete Method

Delete this user from KiiCloud.

Syntax

public void Delete ()

Exceptions

Type	Reason
InvalidOperationException	Is thrown when user ID is empty.
KiiCorp.Cloud.Storage.CloudException	Is thrown when server sends error response.

Remarks

If this user currently logged in, LogOut will be done and cached user info and token in the SDK will be cleared.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Delete Method

Delete this user from KiiCloud.

Syntax

public void Delete (KiiCallback callback)

Parameters

callback

Callback.

Remarks

If this user currently logged in, LogOut will be done and cached user info and token in the SDK will be cleared.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Disabled Property

Return true if the user is disabled, false otherwise.

Syntax

public bool Disabled { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Call KiiUser.Refresh, or KiiUser.Refresh(KiiUserCallback) prior calling this method to get correct status.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Displayname Property

Gets or sets the displayname.

Syntax

public string Displayname { get; set; }

Value

The displayname.

Exceptions

Type	Reason
ArgumentException	Is thrown when an argument is invalid.

Remarks

Display name must be valid.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Email Property

Gets the email.

Syntax

public string Email { get; }

Value

The email.

Remarks

If email is not set, return null.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

EmailVerified Property

Gets a value whether email verified on KiiCloud.

Syntax

public bool EmailVerified { get; }

Value

true if email verified; otherwise, false.

Remarks

Email verification is done from the verification email sent to the registered email.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Equals Method

Determines whether the specified object is equal to the current KiiCorp.Cloud.Storage.KiiUser.

Syntax

public override bool Equals (object obj)

Parameters

obj

The object to compare with the current KiiCorp.Cloud.Storage.KiiUser.

Returns

true if the specified object is equal to the current KiiCorp.Cloud.Storage.KiiUser; otherwise, false.

Remarks

Return true when the specified KiiCorp.Cloud.Storage.KiiUser is in following conditions.

• KiiUser ID is equal to this one.
• (If KiiUser does not have ID) KiiUser instance is equal to this one.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

FindUserByEmail Method

Finds the user by Email.

Syntax

public static KiiUser FindUserByEmail (string email)

Parameters

email

User's Email.

Returns

KiiUser instance.

Remarks

Email must be valid. See KiiUser.IsValidEmail(string)

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

FindUserByEmail Method

Finds the user by Email.

Syntax

public static void FindUserByEmail (string email, KiiUserCallback callback)

Parameters

email

User's Email.

callback

Callback.

Returns

KiiUser instance.

Remarks

Email must be valid. See KiiUser.IsValidEmail(string)

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

FindUserByPhone Method

Finds the user by phone.

Syntax

public static KiiUser FindUserByPhone (string phone)

Parameters

phone

User's Phone.

Returns

KiiUser instance

Remarks

Phone must be valid. See KiiUser.IsValidPhone(string)

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

FindUserByPhone Method

Finds the user by phone.

Syntax

public static void FindUserByPhone (string phone, KiiUserCallback callback)

Parameters

phone

User's Phone.

callback

Callback.

Returns

KiiUser instance

Remarks

Phone must be valid. See KiiUser.IsValidPhone(string)

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

FindUserByUserName Method

Finds the user by UserName

Syntax

public static KiiUser FindUserByUserName (string username)

Parameters

username

User's Username.

Returns

KiiUser instance.

Exceptions

Type	Reason
KiiCorp.Cloud.Storage.IllegalKiiBaseObjectFormatException	Is thrown when server sends broken Json.

Remarks

Username must be valid. See KiiUser.IsValidUserName(string)

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

FindUserByUserName Method

Finds the user by UserName

Syntax

public static void FindUserByUserName (string username, KiiUserCallback callback)

Parameters

username

User's Username.

callback

Callback.

Returns

KiiUser instance.

Exceptions

Type	Reason
KiiCorp.Cloud.Storage.IllegalKiiBaseObjectFormatException	Is thrown when server sends broken Json.

Remarks

Username must be valid. See KiiUser.IsValidUserName(string)

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

GetAccessTokenDictionary Method

Return the access tokens in a dictionary.

Syntax

public Dictionary<string, object> GetAccessTokenDictionary ()

Returns

Access token dictionary or null if user is not logged-in.

Remarks

Key	Type	Value
access_token	string	required for accessing KiiCloud.
expires_at	DateTime	Access token expiration time.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

GetHashCode Method

Serves as a hash function for a KiiCorp.Cloud.Storage.KiiUser object.

Syntax

public override int GetHashCode ()

Returns

A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a hash table.

Remarks

If this KiiUser instance has user ID, hash code is based on its ID. Otherwise, hash codes is based on an object's reference.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

GetSocialAccessTokenDictionary Method

Return the access token and related information of access token for logged-in social network in a dictionary.

Syntax

public Dictionary<string, object> GetSocialAccessTokenDictionary ()

Returns

Access token and related information dictionary for the provider or null if user is not logged-in a social network.

Remarks

Key	Type	Value
oauth_token	string	access token for the provider.
oauth_token_secret	string	access token secret for the provider.
provider_user_id	string	user id of the provider
provider	KiiCorp.Cloud.Storage.Connector.Provider	value to identity the provider.
kii_new_user	bool	Indicates if user was created during connection.
oauth_token_expires_in	long	Social provider's token expiration time.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

ID Property

Returns the ID of this user.

Syntax

public string ID { get; }

Value

The user ID.

Remarks

If the user has not saved to the cloud, returns null.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

IsLinkedWithSocialProvider Method

Determines whether this instance is linked with specified social provider.

Syntax

public bool IsLinkedWithSocialProvider (KiiCorp.Cloud.Storage.Connector.Provider provider)

Parameters

provider

Provider.

Returns

true if this instance is linked social provider the specified provider; otherwise, false.

Remarks

Before call this method, calling the KiiUser.Refresh method is necessary to get the correct value.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

IsPseudoUser Property

Gets a value whether user is pseudo.

Syntax

public bool IsPseudoUser { get; }

Value

true if user is pseudo; otherwise, false.

Remarks

If this method is not called for current login user, calling the Refresh() method is necessary to get a correct value.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

IsValidCountry Method

Determines whether an argument is valid country.

Syntax

public static bool IsValidCountry (string country)

Parameters

country

Country you want to check.

Returns

true if an argument is valid country ; otherwise, false.

Remarks

Valid country is

• Not null
• Matches ^[A-Z]{2}$

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

IsValidDisplayName Method

Determines whether an argument is valid display name.

Syntax

public static bool IsValidDisplayName (string displayname)

Parameters

displayname

Display name you want to check.

Returns

true if an argument is valid display name ; otherwise, false.

Remarks

Valid display name is

• Not null
• Length is 1 - 50

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

IsValidEmail Method

Determines whether an argument is valid email.

Syntax

public static bool IsValidEmail (string email)

Parameters

email

Email you want to check

Returns

true if an argument is valid email ; otherwise, false.

Remarks

Valid email is

• Not null
• Not empty
• matches ^[a-zA-Z0-9\\+\\.\\_\\%\\-\\+]{1,256}\\@[a-zA-Z0-9][a-zA-Z0-9\\-]{0,64}(\\.[a-zA-Z0-9][a-zA-Z0-9\\-]{0,25})+$

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

IsValidGlobalPhone Method

Determines whether an argument is valid global phone.

Syntax

public static bool IsValidGlobalPhone (string phone)

Parameters

phone

Global phone number you want to check

Returns

true if an argument is valid global phone ; otherwise, false.

Remarks

Valid global phone is

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

IsValidLocalPhone Method

Determines whether an argument is valid local phone.

Syntax

public static bool IsValidLocalPhone (string phone)

Parameters

phone

Local phone number you want to check

Returns

true if an argument is valid local phone ; otherwise, false.

Remarks

Valid local phone is

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

IsValidPassword Method

Determines whether an argument is valid password.

Syntax

public static bool IsValidPassword (string password)

Parameters

password

Password you want to check.

Returns

true if an argument is valid password ; otherwise, false.

Remarks

Valid password is

• Not null
• Matches ^[a-zA-Z0-9]{4,64}$

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

IsValidPhone Method

Determines whether an argument is valid phone.

Syntax

public static bool IsValidPhone (string phone)

Parameters

phone

Phone number you want to check

Returns

true if an argument is valid phone ; otherwise, false.

Remarks

Valid phone is

• Not null
• matches ^[\\+]?[0-9.-]+

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

IsValidUserName Method

Determines whether an argument is valid user name.

Syntax

public static bool IsValidUserName (string username)

Parameters

username

username you want to check

Returns

true if an argument is valid user name ; otherwise, false.

Remarks

Valid username is

• Not null.
• matches [a-zA-Z0-9-_\\.]{3,64}$

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

LinkedSocialAccounts Property

Gets the linked social accounts.

Syntax

public Dictionary<KiiCorp.Cloud.Storage.Connector.Provider, KiiCorp.Cloud.Storage.Connector.SocialAccountInfo> LinkedSocialAccounts { get; }

Value

Dictionary<Provider,SocialAccountInfo> Provider as key and SocialAccountInfo as value

Remarks

Before call this method, calling the KiiUser.Refresh method is necessary. Otherwise, empty list will be returned.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

LinkWithSocialNetwork Method

Links the with social network.

Syntax

public KiiUser LinkWithSocialNetwork (Dictionary<string, string> accessCredential, KiiCorp.Cloud.Storage.Connector.Provider provider)

Parameters

accessCredential

following parameters can be assigned to bundle:

Key	Value
accessToken	Access token
accessTokenSecret	Access Token Secret for Twitter integration
openID	OpenID for QQ integration

provider

Social Network Provider.It must be FACEBOOK, GOOGLE, GOOGLEPLUS, TWITTER, RENREN or QQ.

Returns

KiiUser instance.

Exceptions

Type	Reason
ArgumentException	Is thrown when an argument is invalid.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

LinkWithSocialNetwork Method

Links the with social network.

Syntax

public void LinkWithSocialNetwork (Dictionary<string, string> accessCredential, KiiCorp.Cloud.Storage.Connector.Provider provider, KiiGenericsCallback<KiiUser> callback)

Parameters

accessCredential

following parameters can be assigned to bundle:

Key	Value
accessToken	Access token
accessTokenSecret	Access Token Secret for Twitter integration
openID	OpenID for QQ integration

provider

Social Network Provider.It must be FACEBOOK, GOOGLE, GOOGLEPLUS, TWITTER, RENREN or QQ.

callback

Callback.

Exceptions

Type	Reason
ArgumentNullException	Is thrown when callback is null.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

ListTopics Method

Gets the list of topics in this user scope.

Syntax

public KiiListResult<KiiTopic> ListTopics ()

Returns

A list of the topics in this user scope.

Exceptions

Type	Reason
KiiCorp.Cloud.Storage.CloudException	Is thrown when server sends error response.
KiiCorp.Cloud.Storage.UnauthorizedException	Is thrown when this method called by anonymous user.
InvalidOperationException	Is thrown when this instance does not have ID

Remarks

This api sends a request to server.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

ListTopics Method

Asynchronous call for KiiUser.ListTopics.

Syntax

public void ListTopics (KiiGenericsCallback<KiiListResult<KiiTopic>> callback)

Parameters

callback

Callback.

Exceptions

Type	Reason
KiiCorp.Cloud.Storage.CloudException	Is thrown when server sends error response.

Remarks

This api sends a request to server.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

ListTopics Method

Gets the list of next page of topics in this user scope.

Syntax

public KiiListResult<KiiTopic> ListTopics (string paginationKey)

Parameters

paginationKey

Specifies the pagination key that is obtained by KiiListResult`1.PaginationKey. If specified null or empty, it's same as the KiiUser.ListTopics.

Returns

A list of the topics in this user scope.

Exceptions

Type	Reason
KiiCorp.Cloud.Storage.CloudException	Is thrown when server sends error response.
KiiCorp.Cloud.Storage.UnauthorizedException	Is thrown when this method called by anonymous user.

Remarks

This api sends a request to server.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

ListTopics Method

Asynchronous call for KiiUser.ListTopics(string).

Syntax

public void ListTopics (string paginationKey, KiiGenericsCallback<KiiListResult<KiiTopic>> callback)

Parameters

paginationKey

Specifies the pagination key that is obtained by KiiListResult`1.PaginationKey. If specified null or empty, it's same as the KiiUser.ListTopics(KiiGenericsCallback<KiiListResult<KiiTopic>>).

callback

Callback.

Exceptions

Type	Reason
KiiCorp.Cloud.Storage.CloudException	Is thrown when server sends error response.

Remarks

This api sends a request to server.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Locale Property

Gets or sets the locale.

Syntax

public LocaleContainer Locale { get; set; }

Value

The locale.

Exceptions

Type	Reason
ArgumentException	Is thrown when an argument is null.

Remarks

locale must be not null.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

LogIn Method

Login with username/email/phone and password.

Syntax

public static KiiUser LogIn (string userIdentifier, string password)

Parameters

userIdentifier

Username, email or phone.

password

User's password.

Returns

KiiUser instance.

Remarks

UserIdentifier is username, email or phone.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

LogIn Method

Login with username/email/phone and password.

Syntax

public static void LogIn (string userIdentifier, string password, KiiUserCallback callback)

Parameters

userIdentifier

Username, email or phone.

password

User's password.

callback

Callback delegate. If exception is null, execution is succeeded.

Returns

KiiUser instance.

Remarks

UserIdentifier is username, email or phone.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

LoginWithFacebookToken Method

Login with Facebook Token.

Syntax

public static KiiUser LoginWithFacebookToken (string facebookToken)

Parameters

facebookToken

Facebook Access token.

Returns

KiiUser instance.

Exceptions

Type	Reason
ArgumentException	Is thrown when an argument is invalid.
KiiCorp.Cloud.Storage.IllegalKiiBaseObjectFormatException	Is thrown when Server sends Json string which is not parserable.

Remarks

If token is valid, The user is stored as CurrentUser. Facebook app id must be configured in app settings on the developer console. If successful, the user is cached inside SDK as current user, and accessible via KiiUser.CurrentUser. This user token and token expiration is also cached and can be get by KiiUser.GetAccessTokenDictionary. Access token won't be expired unless you set it explicitly by Kii.AccessTokenExpiration.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

LoginWithFacebookToken Method

Login with Facebook Token.

Syntax

public static void LoginWithFacebookToken (string facebookToken, KiiUserCallback callback)

Parameters

facebookToken

Access token.

callback

Callback.

Exceptions

Type	Reason
ArgumentException	Is thrown when an argument is invalid.
KiiCorp.Cloud.Storage.IllegalKiiBaseObjectFormatException	Is thrown when Server sends Json string which is not parserable.

Remarks

If token is valid, The user is stored as CurrentUser. Facebook app id must be configured in app settings on the developer console.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

LogInWithLocalPhone Method

LogIn with local phone number, country and password.

Syntax

public static KiiUser LogInWithLocalPhone (string localPhoneNumber, string password, string country)

Parameters

localPhoneNumber

Local phone number. Must be valid.

password

Password. Must be valid.

country

Country. Must be valid.

Returns

KiiUser instance.

Remarks

Phone number must be valid local Phone number. Country must be valid country code.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

LogInWithLocalPhone Method

LogIn with local phone number, country and password.

Syntax

public static void LogInWithLocalPhone (string localPhoneNumber, string password, string country, KiiUserCallback callback)

Parameters

localPhoneNumber

Local phone number. Must be valid.

password

Password. Must be valid.

country

Country. Must be valid.

callback

Callback

Remarks

Phone number must be valid local Phone number. Country must be valid country code.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

LoginWithSocialNetwork Method

Logins the with social network token.

Syntax

public static KiiUser LoginWithSocialNetwork (Dictionary<string, string> accessCredential, KiiCorp.Cloud.Storage.Connector.Provider provider)

Parameters

accessCredential

following parameters can be assigned to bundle:

Key	Value
accessToken	Access token
accessTokenSecret	Access Token Secret for Twitter integration
openID	OpenID for QQ integration

provider

Social Network Provider.It must be FACEBOOK, GOOGLE, GOOGLEPLUS, TWITTER, RENREN or QQ.

Returns

KiiUser instance.

Exceptions

Type	Reason
ArgumentException	Is thrown when an argument is invalid.
KiiCorp.Cloud.Storage.IllegalKiiBaseObjectFormatException	Is thrown when Server sends Json string which is not parserable.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

LoginWithSocialNetwork Method

Login with Social Network Token.

Syntax

public static void LoginWithSocialNetwork (Dictionary<string, string> accessCredential, KiiCorp.Cloud.Storage.Connector.Provider provider, KiiGenericsCallback<KiiUser> callback)

Parameters

accessCredential

following parameters can be assigned to bundle:

Key	Value
accessToken	Access token
accessTokenSecret	Access Token Secret for Twitter integration
openID	OpenID for QQ integration

provider

Social Network Provider.It must be FACEBOOK, GOOGLE, GOOGLEPLUS, TWITTER, RENREN or QQ.

callback

Callback.

Exceptions

Type	Reason
ArgumentNullException	Is thrown when callback is null.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

LoginWithToken Method

Login with Access Token.

Syntax

public static KiiUser LoginWithToken (string token)

Parameters

token

Access token.

Returns

KiiUser instance.

Exceptions

Type	Reason
ArgumentException	Is thrown when an argument is invalid.
KiiCorp.Cloud.Storage.IllegalKiiBaseObjectFormatException	Is thrown when Server sends Json string which is not parserable.

Remarks

If successful, the user is cached inside SDK as current user, and accessible via KiiUser.CurrentUser. Specified token is also cached and can be get by KiiUser.GetAccessTokenDictionary. Note that, token expiration time is not cached and set to DateTime.MaxValue in the dicitonary. If you want token expiration time also be cached, use KiiUser.LoginWithToken(string, DateTime) instead.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

LoginWithToken Method

Login with Access Token.

Syntax

public static void LoginWithToken (string token, KiiUserCallback callback)

Parameters

token

Access token.

callback

Callback.

Exceptions

Type	Reason
ArgumentException	Is thrown when an argument is invalid.
KiiCorp.Cloud.Storage.IllegalKiiBaseObjectFormatException	Is thrown when Server sends Json string which is not parserable.

Remarks

If successful, the user is cached inside SDK as current user, and accessible via KiiUser.CurrentUser. Specified token is also cached and can be get by KiiUser.GetAccessTokenDictionary. Note that, token expiration time is not cached and set to DateTime.MaxValue in the dicitonary. If you want token expiration time also be cached, use KiiUser.LoginWithToken(string, DateTime, KiiUserCallback) instead. Login again to renew the token.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

LoginWithToken Method

Login with Access Token.

Syntax

public static KiiUser LoginWithToken (string token, DateTime expiresAt)

Parameters

token

Access token.

expiresAt

Access token expire time that has received by KiiUser.GetAccessTokenDictionary.

Returns

KiiUser instance.

Exceptions

Type	Reason
ArgumentException	Is thrown when specified token is null/empty.
KiiCorp.Cloud.Storage.CloudException	Is thrown when server sends error response.
KiiCorp.Cloud.Storage.IllegalKiiBaseObjectFormatException	Is thrown when Server sends Json string which is not parserable.

Remarks

Specified expiresAt won't be used by SDK. IF login successful, we set this property so that you can get it later along with token by KiiUser.GetAccessTokenDictionary. Also, if successful, returned user is cached inside SDK as current user, and accessible via KiiUser.CurrentUser.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

LoginWithToken Method

Login with Access Token.

Syntax

public static void LoginWithToken (string token, DateTime expiresAt, KiiUserCallback callback)

Parameters

token

Access token.

expiresAt

Access token expire time that has received by KiiUser.GetAccessTokenDictionary.

callback

Callback.

Exceptions

Type	Reason
ArgumentException	Is thrown when specified token is null/empty or callback is null.

Remarks

Specified expiresAt won't be used by SDK. IF login successful, we set this property so that you can get it later along with token by KiiUser.GetAccessTokenDictionary. Also, if successful, returned user is cached inside SDK as current user, and accessible via KiiUser.CurrentUser.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

LogOut Method

Logout Current User

Syntax

public static void LogOut ()

Remarks

Logout Current User

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

MemberOfGroups Method

Returns the list of groups which the user is a member of.

Syntax

public IList<KiiGroup> MemberOfGroups ()

Returns

The list of groups.

Exceptions

Type	Reason
InvalidOperationException	Is thrown when this instance doesn't have ID
KiiCorp.Cloud.Storage.IllegalKiiBaseObjectFormatException	Is thrown when server sends broken Json

Remarks

Group item in the list does not contain all the property of group. To get all the property from cloud, a KiiGroup.Refresh() is necessary.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

MemberOfGroups Method

Returns the list of groups which the user is a member of.

Syntax

public void MemberOfGroups (KiiGroupListCallback callback)

Parameters

callback

Callback.

Exceptions

Type	Reason
InvalidOperationException	Is thrown when this instance doesn't have ID
KiiCorp.Cloud.Storage.IllegalKiiBaseObjectFormatException	Is thrown when server sends broken Json

Remarks

Group item in the list does not contain all the property of group. To get all the property from cloud, a KiiGroup.Refresh() is necessary.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

OwnerOfGroups Method

Returns the groups owned by this user.

Syntax

public IList<KiiGroup> OwnerOfGroups ()

Returns

The list of groups.

Exceptions

Type	Reason
InvalidOperationException	Is thrown when this instance doesn't have ID
KiiCorp.Cloud.Storage.IllegalKiiBaseObjectFormatException	Is thrown when server sends broken Json

Remarks

Group in the list does not contain all the property of group. To get all the property from cloud, a KiiGroup.Refresh is necessary.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

OwnerOfGroups Method

Returns the groups owned by this user.

Syntax

public void OwnerOfGroups (KiiGroupListCallback callback)

Parameters

callback

Callback.

Exceptions

Type	Reason
InvalidOperationException	Is thrown when this instance doesn't have ID
KiiCorp.Cloud.Storage.IllegalKiiBaseObjectFormatException	Is thrown when server sends broken Json

Remarks

Group in the list does not contain all the property of group. To get all the property from cloud, a KiiGroup.Refresh is necessary.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

PendingEmail Property

Get the email of this user that has not been verified. When the user's email has been changed and email verification is required in you app configuration, New email is stored as pending email. After the new email has been verified, the address can be obtained by KiiUser.Email

Syntax

public string PendingEmail { get; }

Value

The pending email.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

PendingPhone Property

Get the phone of this user that has not been verified. When the user's phone has been changed and phone verification is required in you app configuration, New phone is stored as pending phone. After the new phone has been verified, the number can be obtained by KiiUser.Phone

Syntax

public string PendingPhone { get; }

Value

The pending phone.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Phone Property

Gets the phone number.

Syntax

public string Phone { get; }

Value

The phone.

Remarks

If phone is not set, return null.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

PhoneVerified Property

Gets a value whether phone verified on KiiCloud.

Syntax

public bool PhoneVerified { get; }

Value

true if phone verified; otherwise, false.

Remarks

Phone verification is done when VerifyPhone(string) is called successfully.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

PushInstallation Method

Get KiiPushInstallation instance of current logged in user. The installation will be created for production. (Same as calling KiiUser.PushInstallation(bool) with false.) You can control sending message to production/development installation, by specifying the flag when sending push message.

Syntax

public static KiiPushInstallation PushInstallation ()

Returns

The installation.

Remarks

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

PushInstallation Method

Get KiiPushInstallation instance of current logged in user. development : true would be used for testing push before release application / new version. other wise, use KiiUser.PushInstallation. You can control sending message to production/ development installation, by specifying the flag when sending push message.

Syntax

public static KiiPushInstallation PushInstallation (bool development)

Parameters

development

If set to true development.

Returns

The installation.

Remarks

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

PushSubscription Property

Get KiiPushSubscription instance of the user. The user will subscribe to the push service by using the returned instance.

Syntax

public KiiPushSubscription PushSubscription { get; }

Value

KiiPushSubscription Instance of KiiPushSubscription.

Remarks

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

PutIdentity Method

Puts identity data to pseudo user. This method is exclusive to pseudo user. If this method is called for user who has identity, KiiCorp.Cloud.Storage.AlreadyHasIdentityException will be thrown.

Syntax

public void PutIdentity (IdentityData identityData, UserFields userFields, string password)

Parameters

identityData

Mandatory.

userFields

Optional. If null is passed, display name, country and other custom field would not be updated. To update those fields, create userFields instance and pass to this api. Fields which is not included in this instance would not be updated. (current value would be retained)

password

Mandatory. New password is required to put Identity.

Exceptions

Type	Reason
InvalidOperationException	Is thrown when current user is not pseudo user.
ArgumentNullException	Is thrown when identityData is null.
ArgumentException	Is thrown when an argument is invalid.
KiiCorp.Cloud.Storage.CloudException	Is thrown when server sends error response.
KiiCorp.Cloud.Storage.AlreadyHasIdentityException	if a pseudo user already has identity.

Remarks

This user must be current user. password is mandatory and needs to provide at least one of login name, email address or phone number. Local modification done by KiiUser.Country, KiiUser.Displayname and other properties in KiiCorp.Cloud.Storage.KiiUser will be ignored. Please make sure to set new values in UserFields.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

PutIdentity Method

Puts identity data to pseudo user. This method is exclusive to pseudo user. If this method is called for user who has identity, KiiCorp.Cloud.Storage.AlreadyHasIdentityException will be passed to callback.

Syntax

public void PutIdentity (IdentityData identityData, UserFields userFields, string password, KiiUserCallback callback)

Parameters

identityData

Mandatory.

userFields

Optional. If null is passed, display name, country and other custom field would not be updated. To update those fields, create userFields instance and pass to this api. Fields which is not included in this instance would not be updated. (current value would be retained)

password

Mandatory. New password is required to put Identity.

callback

Callback.

Exceptions

Type	Reason
ArgumentNullException	Is thrown when an argument is null or empty.

Remarks

This user must be current user. password is mandatory and needs to provide at least one of login name, email address or phone number. Local modification done by KiiUser.Country, KiiUser.Displayname and other properties in KiiCorp.Cloud.Storage.KiiUser will be ignored. Please make sure to set new values in UserFields.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Refresh Method

Refresh this instance.

Syntax

public void Refresh ()

Exceptions

Type	Reason
InvalidOperationException	Is thrown when this instance does not have ID
KiiCorp.Cloud.Storage.IllegalKiiBaseObjectFormatException	Is thrown when server sends broken Json object.
KiiCorp.Cloud.Storage.CloudException	Is thrown when server sends error response.

Remarks

Getting user profile from KiiCloud and refresh related properties.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Refresh Method

Refresh this instance.

Syntax

public void Refresh (KiiUserCallback callback)

Parameters

callback

Callback.

Remarks

Getting user profile from KiiCloud and refresh related properties.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Register Method

Register this user on KiiCloud.

Syntax

public void Register (string password)

Parameters

password

Password.

Exceptions

Type	Reason
ArgumentException	Is thrown when an argument is invalid.
KiiCorp.Cloud.Storage.IllegalKiiBaseObjectFormatException	Is thrown when server sends illegal JSON object.
KiiCorp.Cloud.Storage.CloudException	Is thrown when server sends error response.

Remarks

Register this user on KiiCloud. Password must be valid.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Register Method

Register this user on KiiCloud.

Syntax

public void Register (string password, KiiUserCallback callback)

Parameters

password

Password.

callback

Callback.

Remarks

Register this user on KiiCloud. Password must be valid.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

RegisterAsPseudoUser Method

Register as pseudo user on KiiCloud.

Syntax

public static KiiUser RegisterAsPseudoUser (UserFields userFields)

Parameters

userFields

Optional. If null is passed, display name, country and other custom field would not be set.

Returns

Registered KiiUser instance.

Exceptions

Type	Reason
KiiCorp.Cloud.Storage.CloudException	Is thrown when server sends error response.

Remarks

When successfully registered, get access token by KiiUser.AccessToken and store it for later use.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

RegisterAsPseudoUser Method

Register as pseudo user on KiiCloud.

Syntax

public static void RegisterAsPseudoUser (UserFields userFields, KiiUserCallback callback)

Parameters

userFields

Optional. If null is passed, display name, country and other custom field would not be set.

callback

Callback.

Exceptions

Type	Reason
ArgumentNullException	Is thrown when callback is null.

Remarks

When successfully registered, get access token by KiiUser.AccessToken and store it for later use.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

RequestResendEmailVerification Method

Requests for letting server send email verification.

Syntax

public static void RequestResendEmailVerification ()

Exceptions

Type	Reason
KiiCorp.Cloud.Storage.CloudException	Is thrown when server sends error response.

Remarks

LogIn is required.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

RequestResendEmailVerification Method

Requests for letting server send email verification.

Syntax

public static void RequestResendEmailVerification (KiiCallback callback)

Parameters

callback

Callback.

Remarks

LogIn is required.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

RequestResendPhoneVerificationCode Method

Requests for letting server send phone verification code.

Syntax

public static void RequestResendPhoneVerificationCode ()

Exceptions

Type	Reason
KiiCorp.Cloud.Storage.CloudException	Is thrown when server sernds error response.

Remarks

LogIn is required.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

RequestResendPhoneVerificationCode Method

Requests for letting server send phone verification code.

Syntax

public static void RequestResendPhoneVerificationCode (KiiCallback callback)

Parameters

callback

Callback.

Remarks

LogIn is required.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

ResetPassword Method

Resets the password.

Syntax

public static void ResetPassword (string identifier)

Parameters

identifier

Email address which is binded to this user.

Exceptions

Type	Reason
ArgumentException	Is thrown when an argument is not a valid Email address.
KiiCorp.Cloud.Storage.CloudException	Is thrown when server sends error response.

Remarks

Reset the password of current login user. Url for password reset will be sent to the specified identifier..

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

ResetPassword Method

Resets the password.

Syntax

public static void ResetPassword (string identifier, KiiCallback callback)

Parameters

identifier

Email address which is binded to this user.

callback

Callback.

Exceptions

Type	Reason
InvalidOperationException	Is thrown when SDK is not initialized.
ArgumentNullException	Is thrown when a callback is null.

Remarks

Reset the password of current login user. Url for password reset will be sent to the specified identifier..

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

ResetPassword Method

Resets the password.

Syntax

public static void ResetPassword (string identifier, KiiUser.NotificationMethod notificationMethod)

Parameters

identifier

should be valid email address, global phone number or user identifier obtained by KiiUser.ID

notificationMethod

specify destination of message includes reset password link url. different type of identifier and destination can be used as long as user have verified email, phone. (ex. User registers both email and phone. Identifier is email and notificationMethod is SMS.)

Exceptions

Type	Reason
ArgumentException	Is thrown when an argument is not a valid user identifier.
KiiCorp.Cloud.Storage.ConflictException	Is thrown when an action has been invoked at an illegal or inappropriate time.
KiiCorp.Cloud.Storage.CloudException	Is thrown when server sends error response.

Remarks

Reset the password of user specified by given identifier. This api does not execute login after reset completion.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

ResetPassword Method

Resets the password.

Syntax

public static void ResetPassword (string identifier, KiiUser.NotificationMethod notificationMethod, KiiCallback callback)

Parameters

identifier

should be valid email address, global phone number or user identifier obtained by KiiUser.ID

notificationMethod

specify destination of message includes reset password link url. different type of identifier and destination can be used as long as user have verified email, phone. (ex. User registers both email and phone. Identifier is email and notificationMethod is SMS.)

callback

Callback called after completion.

Exceptions

Type	Reason
InvalidOperationException	Is thrown when SDK is not initialized.
ArgumentNullException	Is thrown when a callback is null.

Remarks

Reset the password of user specified by given identifier. This api does not execute login after reset completion.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Subject Property

Gets the subject string.

Syntax

public string Subject { get; }

Value

The subject string.

Remarks

Developers don't need to use this property in their apps.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

System.IEquatable<KiiCorp.Cloud.Storage.KiiUser>.Equals Method

Determines whether the specified KiiCorp.Cloud.Storage.KiiUser is equal to the current KiiCorp.Cloud.Storage.KiiUser.

Syntax

bool System.IEquatable<KiiCorp.Cloud.Storage.KiiUser>.Equals (KiiUser other)

Parameters

other

The KiiCorp.Cloud.Storage.KiiUser to compare with the current KiiCorp.Cloud.Storage.KiiUser.

Returns

true if the specified KiiCorp.Cloud.Storage.KiiUser is equal to the current KiiCorp.Cloud.Storage.KiiUser; otherwise, false.

Remarks

Return true when the specified KiiCorp.Cloud.Storage.KiiUser is in following conditions.

• KiiUser ID is equal to this one.
• (If KiiUser does not have ID) KiiUser instance is equal to this one.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Topic Method

Get instance of user scope topic. The topic bound to this user.

Syntax

public KiiTopic Topic (string name)

Parameters

name

Name of topic.

Returns

KiiTopic bound to this user.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

UnLinkWithSocialNetwork Method

Uns the link with social network.

Syntax

public KiiUser UnLinkWithSocialNetwork (KiiCorp.Cloud.Storage.Connector.Provider provider)

Parameters

provider

Social Network Provider.It must be FACEBOOK, GOOGLE, GOOGLEPLUS, TWITTER, RENREN or QQ.

Returns

KiiUser instance.

Exceptions

Type	Reason
ArgumentException	Is thrown when an argument is invalid.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

UnLinkWithSocialNetwork Method

Uns the link with social network.

Syntax

public void UnLinkWithSocialNetwork (KiiCorp.Cloud.Storage.Connector.Provider provider, KiiGenericsCallback<KiiUser> callback)

Parameters

provider

Social Network Provider.It must be FACEBOOK, GOOGLE, GOOGLEPLUS, TWITTER, RENREN or QQ.

callback

Callback.

Exceptions

Type	Reason
ArgumentNullException	Is thrown when callback is null.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Update Method

Update user.

Syntax

[System.Obsolete("Update() is deprecated, please use Update(IdentityData, UserFields) instead", false)]
public void Update ()

Exceptions

Type	Reason
InvalidOperationException	Is thrown when user is not current user.
KiiCorp.Cloud.Storage.CloudException	Is thrown when server sernds error response.

Remarks

This user must be current user. Before call this method, calling the Refresh() method is necessary to keep custom fields, otherwise custom fields will be gone.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Update Method

Update user.

Syntax

[System.Obsolete("Update(KiiUserCallback) is deprecated, please use Update(IdentityData, UserFields, KiiUserCallback) instead", false)]
public void Update (KiiUserCallback callback)

Parameters

callback

Callback.

Remarks

This user must be current user. Before call this method, calling the Refresh() method is necessary to keep custom fields, otherwise custom fields will be gone.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Update Method

Update user attributes. To update IdentityData of pseudo user, use KiiUser.PutIdentity(IdentityData, UserFields, string)

Syntax

public void Update (UserFields userFields)

Parameters

userFields

To update those fields, create userFields instance and pass to this api. Fields which is not included in this instance would not be updated. (current value would be retained.)

Exceptions

Type	Reason
ArgumentNullException	Is thrown when an argument is null or empty.
InvalidOperationException	Is thrown when user is not current user.

Remarks

Local modification done by KiiUser.Country, KiiUser.Displayname and other properties in KiiCorp.Cloud.Storage.KiiUser will be ignored and lost. Please make sure to set new values in UserFields.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Update Method

Update user attributes. If this method is called for pseudo user with IdentityData, ArgumentException will be thrown. To update IdentityData of pseudo user, use KiiUser.PutIdentity(IdentityData, UserFields, string)

Syntax

public void Update (IdentityData identityData, UserFields userFields)

Parameters

identityData

Optional. If null is passed, Identity data would not be updated and current value would be retained.

userFields

Optional. If null is passed, display name, country and other custom field would not be updated. To update those fields, create userFields instance and pass to this api. Fields which is not included in this instance would not be updated. (current value would be retained.)

Exceptions

Type	Reason
ArgumentException	Is thrown when method is called for pseudo user Is thrown when specified local Phone number with invalid country code.
ArgumentNullException	Is thrown when both arguments are null or empty.
InvalidOperationException	Is thrown when user is not current user.

Remarks

Local modification done by KiiUser.Country, KiiUser.Displayname and other properties in KiiCorp.Cloud.Storage.KiiUser will be ignored and lost. Please make sure to set new values in UserFields.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Update Method

Update user attributes. To update IdentityData of pseudo user, use KiiUser.PutIdentity(IdentityData, UserFields, string)

Syntax

public void Update (UserFields userFields, KiiUserCallback callback)

Parameters

userFields

To update those fields, create userFields instance and pass to this api. Fields which is not included in this instance would not be updated. (current value would be retained.)

callback

Callback.

Exceptions

Type	Reason
ArgumentNullException	Is thrown when an argument is null or empty.

Remarks

Local modification done by KiiUser.Country, KiiUser.Displayname and other properties in KiiCorp.Cloud.Storage.KiiUser will be ignored. Please make sure to set new values in UserFields.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Update Method

Update user attributes. If this method is called for pseudo user with IdentityData, KiiCorp.Cloud.Storage.BadRequestException will be thrown. To update IdentityData of pseudo user, use KiiUser.PutIdentity(IdentityData, UserFields, string)

Syntax

public void Update (IdentityData identityData, UserFields userFields, KiiUserCallback callback)

Parameters

identityData

Optional. If null is passed, Identity data would not be updated and current value would be retained.

userFields

Optional. If null is passed, display name, country and other custom field would not be updated. To update those fields, create userFields instance and pass to this api. Fields which is not included in this instance would not be updated. (current value would be retained.)

callback

Callback.

Exceptions

Type	Reason
ArgumentNullException	Is thrown when an argument is null or empty.

Remarks

Local modification done by KiiUser.Country, KiiUser.Displayname and other properties in KiiCorp.Cloud.Storage.KiiUser will be ignored. Please make sure to set new values in UserFields.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Uri Property

URI of this user.

Syntax

public Uri Uri { get; }

Value

URI of this user.

Remarks

To get KiiUser instance, call KiiUser.CreateByUri(Uri).

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

Username Property

Gets the username.

Syntax

public string Username { get; }

Value

The username.

Remarks

If username is not set, return null.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

UserWithID Method

KiiUser.Phone Instantiate KiiUser that refers to existing user which has specified ID.

Syntax

public static KiiUser UserWithID (string userID)

Parameters

userID

ID of the user to instantiate.

Returns

KiiUser instance.

Exceptions

Type	Reason
ArgumentException	Is thrown when specified userID is null or empty.

Remarks

You have to specify the ID of existing KiiUser. Unlike KiiObject, you can not assign ID in the client side. This API does not access to the server. After instantiation, call KiiUser.Refresh to fetch the properties.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

VerifyPhone Method

Verifies the user.

Syntax

public void VerifyPhone (string code)

Parameters

code

Verificatoin conde on SMS sent by KiiCloud.

Exceptions

Type	Reason
ArgumentException	Is thrown when an argument is empty.
KiiCorp.Cloud.Storage.IllegalKiiBaseObjectFormatException	Is thrown when server sends broken Json.
KiiCorp.Cloud.Storage.CloudException	Is thrown when server sends error response.

Remarks

Verify this user's phone number with verification code in SMS sent by KiiCloud.

Verification code is sent from Kii Cloud when new user is registered with phone number or user requested to change their phone number in the application which requires phone verification.

(You can enable/disable phone verification through the console in developer.kii.com)

After the verification succeeded, new phone number becomes users phone number and user is able to login with the phone number.

To get the new phone number, please call KiiUser.Refresh(KiiUserCallback) before access to KiiUser.Phone Before completion of KiiUser.Refresh(KiiUserCallback), value of KiiUser.Phone is cached phone number. It could be old phone number or null.

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---

VerifyPhone Method

Verifies the user.

Syntax

public void VerifyPhone (string code, KiiUserCallback callback)

Parameters

code

Verificatoin conde on SMS sent by KiiCloud.

callback

Callback.

Remarks

Verify this user with verification code on SMS sent by KiiCloud.

This method is asynchronous version of KiiUser.VerifyPhone(string)

Requirements

Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: 3.2.10.0

---