Provides APIs for user management features.
See Also: Inherited members from KiiBaseObject.
| [read-only] static |
AccessToken | string . Gets the access token. |
|
|
Country | string . Gets or sets the country. |
| [read-only] static |
CurrentUser | KiiUser . Gets the current user. |
| [read-only] | Disabled | bool . Return true if the user is disabled, false otherwise. |
|
|
Displayname | string . Gets or sets the displayname. |
| [read-only] | string . Gets the email. | |
| [read-only] | EmailVerified | bool . Gets a value whether email verified on KiiCloud. |
| [read-only] | ID | string . Returns the ID of this user. |
| [read-only] | IsPseudoUser | bool . Gets a value whether user is pseudo. |
|
default property
|
Item (string) | object . Gets or sets the object with the specified key. (Inherited from KiiBaseObject.) |
| [read-only] | LinkedSocialAccounts | Dictionary<KiiCorp.Cloud.Storage.Connector.Provider, KiiCorp.Cloud.Storage.Connector.SocialAccountInfo> . Gets the linked social accounts. |
|
|
Locale | LocaleContainer . Gets or sets the locale. |
| [read-only] | PendingEmail | string . 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 |
| [read-only] | PendingPhone | string . 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 |
| [read-only] | Phone | string . Gets the phone number. |
| [read-only] | PhoneVerified | bool . Gets a value whether phone verified on KiiCloud. |
| [read-only] | PushSubscription | KiiPushSubscription . Get KiiPushSubscription instance of the user. The user will subscribe to the push service by using the returned instance. |
| [read-only] | Subject | string . Gets the subject string. |
| [read-only] | Uri | Uri . URI of this user. |
| [read-only] | Username | string . Gets the username. |
|
|
Bucket
(string)Returns bucket belongs to this user. |
|
|
static
|
BuilderWithEmail
(string)Create Builder with email. |
|
|
static
|
BuilderWithIdentifier
(string)Create Builder with identifier. |
|
|
static
|
BuilderWithLocalPhone
(string, string)Create Builder with local phone. |
|
|
static
|
BuilderWithName
(string)Create Builder with user name. |
|
|
static
|
BuilderWithPhone
(string)Create Builder with phone. |
|
|
static
|
ChangeEmail
(string)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 |
|
|
static
|
ChangeEmail
(string, KiiCallback)Changes the email of CurrentUser |
|
|
static
|
ChangePassword
(string, string)Changes the password of CurrentUser. |
|
|
static
|
ChangePassword
(string, string, KiiCallback)Changes the password of CurrentUser. |
|
|
static
|
ChangePhone
(string)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 |
|
|
static
|
ChangePhone
(string, KiiCallback)Changes the phone number of CurrentUser. |
|
|
static
|
CompleteResetPassword
(string, string, string)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. |
|
|
static
|
CompleteResetPassword
(string, string, string, KiiCallback)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. |
|
|
static
|
CreateByUri
(Uri)Creates KiiUser instance by URI. |
|
|
|
Delete
()Delete this user from KiiCloud. |
|
|
|
Delete
(KiiCallback)Delete this user from KiiCloud. |
|
|
override
|
Equals
(object)Determines whether the specified object is equal to the current KiiCorp.Cloud.Storage.KiiUser. |
|
|
static
|
FindUserByEmail
(string)Finds the user by Email. |
|
|
static
|
FindUserByEmail
(string, KiiUserCallback)Finds the user by Email. |
|
|
static
|
FindUserByPhone
(string)Finds the user by phone. |
|
|
static
|
FindUserByPhone
(string, KiiUserCallback)Finds the user by phone. |
|
|
static
|
FindUserByUserName
(string)Finds the user by UserName |
|
|
static
|
FindUserByUserName
(string, KiiUserCallback)Finds the user by UserName |
|
|
|
GetAccessTokenDictionary
()Return the access tokens in a dictionary. |
|
|
|
GetBoolean
(string)Gets the boolean in KiiBaseObject. (Inherited from KiiBaseObject.) |
|
|
|
GetBoolean
(string, bool)Gets the boolean. If key is not found, returns fallback. (Inherited from KiiBaseObject.) |
|
|
|
GetByteArray
(string)Gets the byte array with the specified key. (Inherited from KiiBaseObject.) |
|
|
|
GetDouble
(string)Gets the double in KiiBaseObject. (Inherited from KiiBaseObject.) |
|
|
|
GetDouble
(string, double)Gets the double. If key is not found, returns fallback. (Inherited from KiiBaseObject.) |
|
|
override
|
GetHashCode
()Serves as a hash function for a KiiCorp.Cloud.Storage.KiiUser object. |
|
|
|
GetInt
(string)Gets the integer in KiiBaseObject. (Inherited from KiiBaseObject.) |
|
|
|
GetInt
(string, int)Gets the integer. If key is not found, returns fallback. (Inherited from KiiBaseObject.) |
|
|
|
GetJsonArray
(string)Gets the Json array with the specified key. (Inherited from KiiBaseObject.) |
|
|
|
GetJsonObject
(string)Gets the JSON object with the specified key. (Inherited from KiiBaseObject.) |
|
|
|
GetLong
(string)Gets the long in KiiBaseObject. (Inherited from KiiBaseObject.) |
|
|
|
GetLong
(string, long)Gets the long. If key is not found, returns fallback. (Inherited from KiiBaseObject.) |
|
|
|
GetSocialAccessTokenDictionary
()Return the access token and related information of access token for logged-in social network in a dictionary. |
|
|
|
GetString
(string)Gets the string in KiiBaseObject. (Inherited from KiiBaseObject.) |
|
|
|
GetString
(string, string)Gets the string. If key is not found, returns fallback. (Inherited from KiiBaseObject.) |
|
|
|
GetUri
(string)Gets the Uri with the specified key. (Inherited from KiiBaseObject.) |
|
|
|
Has
(string)Determine if this instance has the specified key. (Inherited from KiiBaseObject.) |
|
|
|
IsLinkedWithSocialProvider
(KiiCorp.Cloud.Storage.Connector.Provider)Determines whether this instance is linked with specified social provider. |
|
|
static
|
IsValidCountry
(string)Determines whether an argument is valid country. |
|
|
static
|
IsValidDisplayName
(string)Determines whether an argument is valid display name. |
|
|
static
|
IsValidEmail
(string)Determines whether an argument is valid email. |
|
|
static
|
IsValidGlobalPhone
(string)Determines whether an argument is valid global phone. |
|
|
static
|
IsValidLocalPhone
(string)Determines whether an argument is valid local phone. |
|
|
static
|
IsValidPassword
(string)Determines whether an argument is valid password. |
|
|
static
|
IsValidPhone
(string)Determines whether an argument is valid phone. |
|
|
static
|
IsValidUserName
(string)Determines whether an argument is valid user name. |
|
|
|
Keys
()Gets the list of keys (Inherited from KiiBaseObject.) |
|
|
|
LinkWithSocialNetwork
(Dictionary<string, string>, KiiCorp.Cloud.Storage.Connector.Provider)Links the with social network. |
|
|
|
LinkWithSocialNetwork
(Dictionary<string, string>, KiiCorp.Cloud.Storage.Connector.Provider, KiiGenericsCallback<KiiUser>)Links the with social network. |
|
|
|
ListTopics
()Gets the list of topics in this user scope. |
|
|
|
ListTopics
(KiiGenericsCallback<KiiListResult<KiiTopic>>)Asynchronous call for KiiUser.ListTopics. |
|
|
|
ListTopics
(string)Gets the list of next page of topics in this user scope. |
|
|
|
ListTopics
(string, KiiGenericsCallback<KiiListResult<KiiTopic>>)Asynchronous call for KiiUser.ListTopics(string). |
|
|
static
|
LogIn
(string, string)Login with username/email/phone and password. |
|
|
static
|
LogIn
(string, string, KiiUserCallback)Login with username/email/phone and password. |
|
|
static
|
LoginWithFacebookToken
(string)Login with Facebook Token. |
|
|
static
|
LoginWithFacebookToken
(string, KiiUserCallback)Login with Facebook Token. |
|
|
static
|
LogInWithLocalPhone
(string, string, string)LogIn with local phone number, country and password. |
|
|
static
|
LogInWithLocalPhone
(string, string, string, KiiUserCallback)LogIn with local phone number, country and password. |
|
|
static
|
LoginWithSocialNetwork
(Dictionary<string, string>, KiiCorp.Cloud.Storage.Connector.Provider)Logins the with social network token. |
|
|
static
|
LoginWithSocialNetwork
(Dictionary<string, string>, KiiCorp.Cloud.Storage.Connector.Provider, KiiGenericsCallback<KiiUser>)Login with Social Network Token. |
|
|
static
|
LoginWithToken
(string)Login with Access Token. |
|
|
static
|
LoginWithToken
(string, KiiUserCallback)Login with Access Token. |
|
|
static
|
LoginWithToken
(string, DateTime)Login with Access Token. |
|
|
static
|
LoginWithToken
(string, DateTime, KiiUserCallback)Login with Access Token. |
|
|
static
|
LogOut
()Logout Current User |
|
|
|
MemberOfGroups
()Returns the list of groups which the user is a member of. |
|
|
|
MemberOfGroups
(KiiGroupListCallback)Returns the list of groups which the user is a member of. |
|
|
|
OwnerOfGroups
()Returns the groups owned by this user. |
|
|
|
OwnerOfGroups
(KiiGroupListCallback)Returns the groups owned by this user. |
|
|
static
|
PushInstallation
()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. |
|
|
static
|
PushInstallation
(bool)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. |
|
|
|
PutIdentity
(IdentityData, UserFields, string)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. |
|
|
|
PutIdentity
(IdentityData, UserFields, string, KiiUserCallback)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. |
|
|
|
Refresh
()Refresh this instance. |
|
|
|
Refresh
(KiiUserCallback)Refresh this instance. |
|
|
|
Register
(string)Register this user on KiiCloud. |
|
|
|
Register
(string, KiiUserCallback)Register this user on KiiCloud. |
|
|
static
|
RegisterAsPseudoUser
(UserFields)Register as pseudo user on KiiCloud. |
|
|
static
|
RegisterAsPseudoUser
(UserFields, KiiUserCallback)Register as pseudo user on KiiCloud. |
|
|
|
Remove
(string)Remove the specified key and value. (Inherited from KiiBaseObject.) |
|
|
static
|
RequestResendEmailVerification
()Requests for letting server send email verification. |
|
|
static
|
RequestResendEmailVerification
(KiiCallback)Requests for letting server send email verification. |
|
|
static
|
RequestResendPhoneVerificationCode
()Requests for letting server send phone verification code. |
|
|
static
|
RequestResendPhoneVerificationCode
(KiiCallback)Requests for letting server send phone verification code. |
|
|
static
|
ResetPassword
(string)Resets the password. |
|
|
static
|
ResetPassword
(string, KiiCallback)Resets the password. |
|
|
static
|
ResetPassword
(string, KiiUser.NotificationMethod)Resets the password. |
|
|
static
|
ResetPassword
(string, KiiUser.NotificationMethod, KiiCallback)Resets the password. |
|
|
|
Topic
(string)Get instance of user scope topic. The topic bound to this user. |
|
|
|
UnLinkWithSocialNetwork
(KiiCorp.Cloud.Storage.Connector.Provider)Uns the link with social network. |
|
|
|
UnLinkWithSocialNetwork
(KiiCorp.Cloud.Storage.Connector.Provider, KiiGenericsCallback<KiiUser>)Uns the link with social network. |
|
|
|
Update
()Update user. |
|
|
|
Update
(KiiUserCallback)Update user. |
|
|
|
Update
(UserFields)Update user attributes. To update IdentityData of pseudo user, use KiiUser.PutIdentity(IdentityData, UserFields, string) |
|
|
|
Update
(IdentityData, UserFields)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) |
|
|
|
Update
(UserFields, KiiUserCallback)Update user attributes. To update IdentityData of pseudo user, use KiiUser.PutIdentity(IdentityData, UserFields, string) |
|
|
|
Update
(IdentityData, UserFields, KiiUserCallback)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) |
|
|
static
|
UserWithID
(string)KiiUser.Phone Instantiate KiiUser that refers to existing user which has specified ID. |
|
|
|
VerifyPhone
(string)Verifies the user. |
|
|
|
VerifyPhone
(string, KiiUserCallback)Verifies the user. |
|
|
IEquatable<KiiCorp.Cloud.Storage.KiiUser>.Equals | Determines whether the specified KiiCorp.Cloud.Storage.KiiUser is equal to the current KiiCorp.Cloud.Storage.KiiUser. |
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: <IP_ADDRESS>
Returns bucket belongs to this user.Syntax
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: <IP_ADDRESS>
Create Builder with email.Syntax
public static KiiUser.Builder BuilderWithEmail (string email)Parameters
- 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: <IP_ADDRESS>
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: <IP_ADDRESS>
Create Builder with local phone.Syntax
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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.PendingEmailSyntax
[System.Obsolete("ChangeEmail(string) is deprecated, please use Update(IdentityData, CustomFields) instead", false)]
public static void ChangeEmail (string email)Parameters
- 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 validRequirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: <IP_ADDRESS>
Changes the email of CurrentUserSyntax
[System.Obsolete("ChangeEmail(string, KiiCallback) is deprecated, please use Update(IdentityData, CustomFields, KiiUserCallback) instead", false)]
public static void ChangeEmail (string email, KiiCallback callback)Parameters
- New email.
- callback
- Callback.
Remarks
Email must be validRequirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: <IP_ADDRESS>
Changes the password of CurrentUser.Syntax
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: <IP_ADDRESS>
Changes the password of CurrentUser.Syntax
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: <IP_ADDRESS>
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.PendingPhoneSyntax
[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: <IP_ADDRESS>
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: <IP_ADDRESS>
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
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
Creates KiiUser instance by URI.Syntax
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
Determines whether the specified object is equal to the current KiiCorp.Cloud.Storage.KiiUser.Syntax
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: <IP_ADDRESS>
Finds the user by Email.Syntax
Parameters
- 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: <IP_ADDRESS>
Finds the user by Email.Syntax
Parameters
- 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: <IP_ADDRESS>
Finds the user by phone.Syntax
Parameters
- phone
- User's Phone.
Returns
KiiUser instanceRemarks
Phone must be valid. See KiiUser.IsValidPhone(string)Requirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: <IP_ADDRESS>
Finds the user by phone.Syntax
Parameters
- phone
- User's Phone.
- callback
- Callback.
Returns
KiiUser instanceRemarks
Phone must be valid. See KiiUser.IsValidPhone(string)Requirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: <IP_ADDRESS>
Finds the user by UserNameSyntax
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: <IP_ADDRESS>
Finds the user by UserNameSyntax
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
Determines whether an argument is valid country.Syntax
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: <IP_ADDRESS>
Determines whether an argument is valid display name.Syntax
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: <IP_ADDRESS>
Determines whether an argument is valid email.Syntax
Parameters
- 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: <IP_ADDRESS>
Determines whether an argument is valid global phone.Syntax
Parameters
- phone
- Global phone number you want to check
Returns
true if an argument is valid global phone ; otherwise, false.Remarks
Valid global phone isRequirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: <IP_ADDRESS>
Determines whether an argument is valid local phone.Syntax
Parameters
- phone
- Local phone number you want to check
Returns
true if an argument is valid local phone ; otherwise, false.Remarks
Valid local phone isRequirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: <IP_ADDRESS>
Determines whether an argument is valid password.Syntax
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: <IP_ADDRESS>
Determines whether an argument is valid phone.Syntax
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: <IP_ADDRESS>
Determines whether an argument is valid user name.Syntax
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: <IP_ADDRESS>
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 valueRemarks
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
Login with username/email/phone and password.Syntax
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: <IP_ADDRESS>
Login with username/email/phone and password.Syntax
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: <IP_ADDRESS>
Login with Facebook Token.Syntax
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: <IP_ADDRESS>
Login with Facebook Token.Syntax
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
Login with Access Token.Syntax
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: <IP_ADDRESS>
Login with Access Token.Syntax
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: <IP_ADDRESS>
Login with Access Token.Syntax
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: <IP_ADDRESS>
Login with Access Token.Syntax
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: <IP_ADDRESS>
Logout Current UserSyntax
public static void LogOut ()Remarks
Logout Current UserRequirements
Namespace: KiiCorp.Cloud.Storage
Assembly: KiiCloudStorageSDK (in KiiCloudStorageSDK.dll)
Assembly Versions: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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.EmailSyntax
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: <IP_ADDRESS>
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.PhoneSyntax
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
Register this user on KiiCloud.Syntax
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: <IP_ADDRESS>
Register this user on KiiCloud.Syntax
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: <IP_ADDRESS>
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: <IP_ADDRESS>
Register as pseudo user on KiiCloud.Syntax
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
Resets the password.Syntax
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: <IP_ADDRESS>
Resets the password.Syntax
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: <IP_ADDRESS>
Resets the password.Syntax
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
Determines whether the specified KiiCorp.Cloud.Storage.KiiUser is equal to the current KiiCorp.Cloud.Storage.KiiUser.Syntax
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: <IP_ADDRESS>
Get instance of user scope topic. The topic bound to this user.Syntax
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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
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: <IP_ADDRESS>
Update user attributes. To update IdentityData of pseudo user, use KiiUser.PutIdentity(IdentityData, UserFields, string)Syntax
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: <IP_ADDRESS>
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
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: <IP_ADDRESS>
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: <IP_ADDRESS>
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: <IP_ADDRESS>
KiiUser.Phone Instantiate KiiUser that refers to existing user which has specified ID.Syntax
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: <IP_ADDRESS>
Verifies the user.Syntax
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: <IP_ADDRESS>
Verifies the user.Syntax
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: <IP_ADDRESS>


Django: Where does the application start ?
Posted: | More posts about django wsgi learn
The key to understand any kind of application is to know where does it start. Until then you'll keep banging your head, shooting in the dark and lastly, at the mercy of Google when trying to debug or solve any issues you have.
Majority of web developers don't really know, or even care where actually their application start. This particularly true for those developing in PHP which abstract most of the web parts and it appear to developer they just writing a regular command line or desktop application.
For Django developer, you can probably ignore this throughout your dev carrier but knowing it will help you a lot in.
Django application can start (at least) from 2 possible entry point. The first entry point is
through the development server and the second entry point is when you deploy it to production
web server, either mod_wsgi
, gunicorn
, Paste
, Rocket
, Waitress
, Circus
or dozen more
WSGI server you can find on PyPI. I can still remember the day when there's none pure Python
WSGI server exists (except CherryPy) and how I'd really envy Rails's community for having Mongrel.
That day has long gone.
Let's dive to the first entry point - when you run your django application through the
manage.py runserver
command. Typical django application (as generated) by the startproject
command
has a file called manage.py
at the root of the project directory. This is the file that developer use
to interact with their application, doing things such as running development server, synching database
tables with the models definition, loading/exporting data and so much more.
If you peek into manage.py
, it's pretty simple actually:-
#!./bin/python import os import sys if __name__ == "__main__": os.environ.setdefault("DJANGO_SETTINGS_MODULE", "acara.settings") from django.core.management import execute_from_command_line execute_from_command_line(sys.argv)
They key line here is at line 10 where a function called execute_from_command_line()
being called.
From here we can traverse to module django.core.management
to find out what that function is doing.
If you're sure where the actual module is located, just open the python console and import the module
to inspect it's location:-
$ python Python 2.7.3 (default, Aug 1 2012, 05:16:07) [GCC 4.6.3] on linux2 Type "help", "copyright", "credits" or "license" for more information. >>> import django.core.management >>> django.core.management <module 'django.core.management' from '/home../local/lib/...django/core/management/__init__.pyc'>
Now we know that module was in $HOME/local/lib/python2.7/site-packages/django/core/management/__init__.py
.
This one thing I love in python. Everything is explicit. You can easily trace down where things comes from
without even having to understand the whole framework yet. In some other framework or languages where
implicit import is a norm, you'll have hard time tracing down where certain functions or variables comes from
until you know the mechanism of the framework.
Let's look what inside django.core.management
module. The function execute_from_command_line()
was defined
at the bottom of the source code. It just a wrapper to other function actually.
def execute_from_command_line(argv=None): """ A simple method that runs a ManagementUtility. """ utility = ManagementUtility(argv) utility.execute()
ManagementUtility
class however not really interesting. It just some logic to find out which command module to execute
based on user's command parameter. For manage.py runserver
, the python module that will be executed is django/core/management/commands/runserver.py
. So let's take a look into this module:-
def get_handler(self, *args, **options): """ Returns the default WSGI handler for the runner. """ return get_internal_wsgi_application()
This is around line 56 in current master on Github. The import at the top of the module look like this:-
from django.core.servers.basehttp import get_internal_wsgi_application, run
So that would be our next target - django/core/servers/basehttp.py
. The code is like this:-
def get_internal_wsgi_application(): """ Loads and returns the WSGI application as configured by the user in ``settings.WSGI_APPLICATION``. With the default ``startproject`` layout, this will be the ``application`` object in ``projectname/wsgi.py``. This function, and the ``WSGI_APPLICATION`` setting itself, are only useful for Django's internal server (runserver); external WSGI servers should just be configured to point to the correct application object directly. If settings.WSGI_APPLICATION is not set (is ``None``), we just return whatever ``django.core.wsgi.get_wsgi_application`` returns. """ from django.conf import settings app_path = getattr(settings, 'WSGI_APPLICATION') if app_path is None: return get_wsgi_application() try: return import_string(app_path) except ImportError as e: msg = ( "WSGI application '%(app_path)s' could not be loaded; " "Error importing module: '%(exception)s'" % ({ 'app_path': app_path, 'exception': e, }) ) six.reraise(ImproperlyConfigured, ImproperlyConfigured(msg), sys.exc_info()[2])
So now we have the full trace of how from running the command manage.py runserver
, which code is being executed. At this point,
it really helpful if we understand the basic of WSGI spec. Django, at the very core is nothing more than a WSGI application. The
basic of WSGI is like this:-
def application(environ, start_response): start_response('200 OK', [('Content-Type', 'text/html')]) return ['hello world']
And the whole Django framework basically just an expansion of above function. So let's see where does the above snippet from Django would bring us:-
from django.core.wsgi import get_wsgi_application
import django from django.core.handlers.wsgi import WSGIHandler def get_wsgi_application(): """ The public interface to Django's WSGI support. Should return a WSGI callable. Allows us to avoid making django.core.handlers.WSGIHandler public API, in case the internal WSGI implementation changes or moves in the future. """ django.setup() return WSGIHandler()
In django/core/handlers/wsgi.py
:-
class WSGIHandler(base.BaseHandler): initLock = Lock() request_class = WSGIRequest def __call__(self, environ, start_response): # Set up middleware if needed. We couldn't do this earlier, because # settings weren't available. if self._request_middleware is None: with self.initLock: try: # Check that middleware is still uninitialized. if self._request_middleware is None: self.load_middleware() except: # Unload whatever middleware we got self._request_middleware = None raise
Notice the similarity between the above code and the basic WSGI application we have seen here ? The difference is that the Django
code above is using class, instead of simple function but the interface still remained similar as you can see in the method
__call__(self, environ, start_response)
above. This class, when instantiated, the instance will be callable just like function.
So far we've only gone through the request/response part of Django. There's still a lot to cover - ORM, templates, middlewares, forms etc. This post was written in hurry so if I missed some key details, feel free to ask in the comments below.


Meta Analyses
The analyses in this section relate to the database itself, providing information as to the quantity and quality of the information contained in the ADR database. Because of discontinuities in data collection, one should not interpret analyses presented in this section as reflecting the details of year-to-year changes in distance running world-wide but rather reflect general trends. Certainly the numbers of performances qualifying for inclusion in the ADR database has grown since the 1970's, however the factor is not as large as might be inferred from these analyses since coverage has tended to improve in recent years.
Current Statistics
Totals
1,323,596 244,490 45,573 51,355
Notes: The count of performances and races includes grand prix standings,
splits, qualifying heats,
and stage races. The runners qualified by time represent those that have achieved at least one of the ARRS time
standards. Other runners include marathon winners, veterans under the qualifying
standards for their age group, and runners who have won a single prize purse of US$1000
or more, that are not otherwise qualified by time.
Performances
Races
Runners- qualified by time
Runners- other
Most Performances by Individuals 815 Laura Ricci (ITA) 10 Dec 2017 743 Petra Kaminkova (CZE) 10 Dec 2017 684 Tana Metelkova (CZE) 25 Nov 2017 593 Gloria Marconi (ITA) 24 Sep 2017 586 Fabiola Oppliger Rueda (COL=>SUI) 09 Dec 2017 528 Frantisek Pechek (CZE) 28 Oct 2017 519 Giorgio Calcaterra (ITA) 03 Dec 2017 503 Nadezhda Wijenberg (RUS=>NED) 28 Jun 2015 487 Flavia Gaviglio (ITA) 02 Dec 2007 478 Birgit Lennartz (GER) 27 Nov 2016 10 472 Marija Vrajic (CRO) 10 Dec 2017 456 Bill Rodgers (USA) 24 Jul 2017 422 Philemon Kipkering Metto (KEN) 26 Jun 2011 422 Jonathan Wyatt (NZL) 07 Oct 2017 420 Silvia Sommaggio (ITA) 28 Oct 2017 417 Miroslav Vitek (CZE) 28 Sep 2017 407 Simona Staicu (HUN) 23 Oct 2017 406 Aniko Kalovics (HUN) 12 Aug 2017 402 Miroslav Vanko (SVK) 09 Sep 2017 398 Laura Fogli (ITA) 27 Sep 2015 20 Note: Dates represent the most recent performance in the database.
Count of Runners by Nationality
Count of Performances by Nation
Historical
(by year)


This example uses two modules, pageScript.js and lengthConverterModule.js, and has an inline script on this page. The inline script attaches the button.click event handler to the doSampleConversion() function uses the LengthConverter.Convert() method from lengthConverterModule.js.
Because of module security restrictions, this example must be hosted onoliner in a test web server. It will not run successfully from the local file system.


Stark Industries is a large scale technology company, formerly heavily involved with weapons development, but now moving in a new direction, towards clean energy and a better future.
NOTE: The recent news that our former ceo and current owner, Mr. Tony Stark, is the Iron Man, will not affect the running of this company. The Iron Man venture is a personal venture by Mr. Stark, and has nothing to do with our company.
As was said in our recent press conference, Stark Industries will no longer produce weapons.
We understand that this is a shocking new development for a weapons development company to no longer produce weapons, but Mr. Tony Stark and the board of directors have decided that this is the best option for the company to progress. We intend to go forward with our ARC Reactor technology, towards a goal of providing clean energy for the world.


Access Control Management
General
This section covers fundamental concepts of the access control related APIs provided by JCR and Jackrabbit as well as the extensions points defined by Oak.
If you are already familiar with the API and looking for examples you may directly read Using the Access Control Management API for a comprehensive list of method calls as well as examples that may be used to edit the access control content of the repository.
JCR API
Access Control Management is an optional feature defined by JSR 283 consisting of
• Privilege discovery: Determining the privileges that a user has in relation to a node.
• Assigning access control policies: Setting the privileges that a user has in relation to a node using access control policies specific to the implementation.
Whether or not a given implementation supports access control management is defined by the Repository.OPTION_ACCESS_CONTROL_SUPPORTED descriptor.
Since Oak comes with a dedicated privilege management this section focuses on reading and editing access control information. The main interfaces defined by JSR 283 are:
- AccessControlManager: Main entry point for access control related operations
- AccessControlPolicy: Marker interface for any kind of policies defined by the implementation.
- AccessControlList: mutable policy that may have a list of entries.
- NamedAccessControlPolicy: opaque immutable policy with a JCR name.
- AccessControlEntry: association of privilege(s) with a given principal bound to a given node by the AccessControlList.
The JCR access control management has the following characteristics:
- path-based: policies are bound to nodes; a given node may have multiple policies; the null path identifies repository level policies.
- transient: access control related modifications are always transient
- binding: policies are decoupled from the repository; in order to bind a policy to a node or apply modifications made to an existing policy AccessControlManager.setPolicy must be called.
- effect: policies bound to a given node only take effect upon Session.save(). Access to properties is defined by the their parent node.
- scope: a given policy may not only affect the node it is bound to but may have an effect on accessibility of items elsewhere in the workspace.
Jackrabbit API
The Jackrabbit API defines various access control related extensions to the JCR API in order to cover common needs such as for example:
- deny access: access control entries can be defined to deny privileges at a given path (JCR only defines allowing access control entries)
- restrictions: limit the effect of a given access control entry by the mean of restrictions
- convenience:
- reordering of access control entries in a access control list
- retrieve the path of the node a given policy is (or can be) bound to
- principal-based:
- principal-based access control management API (in contrast to the path-based default specified by JSR 283)
- privilege discovery for a set of principals
The following interfaces and extensions are defined:
- JackrabbitAccessControlManager
- JackrabbitAccessControlPolicy
- JackrabbitAccessControlList
- JackrabbitAccessControlEntry
API Extensions
Oak defines the following interfaces extending the access control management API:
- PolicyOwner: Interface to improve pluggability of the access control management and allows to termine if a giving manager handles a given policy.
- AccessControlConstants: Constants related to access control management.
In addition it provides some access control related base classes in org.apache.jackrabbit.oak.spi.security.authorization.accesscontrol that may be used for a custom implementation:
- AbstractAccessControlList: abstract base implementation of the JackrabbitAccessControlList interface
- ImmutableACL: immutable subclass of AbstractAccessControlList
- ACE: abstract subclass that implements common methods of a mutable access control list.
Restriction Management
Oak 1.0 defines a dedicated restriction management API. See Restriction Management for details and further information regarding extensibility and pluggability.
Utilities
The jcr-commons module present with Jackrabbit provide some access control related utilities that simplify the creation of new policies and entries such as for example:
- AccessControlUtils.getAccessControlList(Session, String)
- AccessControlUtils.getAccessControlList(AccessControlManager, String)
- AccessControlUtils.addAccessControlEntry(Session, String, Principal, String[], boolean)
See org.apache.jackrabbit.commons.jackrabbit.authorization.AccessControlUtils for the complete list of methods.
Examples
String path = node.getPath();
JackrabbitAccessControlList acl = AccessControlUtils.getAccessControlList(session, path);
acl.addEntry(principal, privileges, true);
acMgr.setPolicy(path, acl);
session.save();
Configuration
The configuration of the access control management implementation is handled within the AuthorizationConfiguration, which is used for all authorization related matters. This class provides the following two access control related methods:
- getAccessControlManager: get a new ac manager instance.
- getRestrictionProvider: get a new instance of the restriction provider.
Configuration Parameters
The supported configuration options of the default implementation are described in the corresponding section.


{{drop.name}} at {{drop.location}} ({{drop.latitude}},{{drop.longitude}})
{{drop.description}}
this.localState = {{ localState | json }}


In the previous video Steve explained the distinction between inline and block elements. It's not essential that you fully understand the distinction at this point.
What he said about block elements creating "invisible boxes" will be important, but you will learn more about this in the next lesson.
In the next video you will have your first encounter with container elements: elements that do nothing but contain stuff inside of them. The purpose of these elements will not be clear yet, but in the next lesson you will see how these elements can be used to create web pages with complex structures.
span is inline
oh myyyy
.bla bla
That's right! a, span, br, img, and strong are all inline elements while div, p, and form are block elements.
We now recommend using **scratchpad.io** instead of the HTML playground Steve refers to
.boxed {dsfdsfds}
SUMMARY
Thinking about what you've learned
First, recall the two main topics covered in this lesson.
Overview of the Internet: You were shown the big-picture view of how the internet works and were introduced to terms like servers, browsers, the internet, and HTTP.
Introduction to HTML: You were introduced to HTML tags (like b,p, em, ,
, and ) and saw how even though these tags aren't visible to users of a web page, they still carry meaning that is meaningful to web browsers.
These topics were covered quickly and it's okay if you forget a lot of the details. But there are a few points which you should keep with you.
What to take away from this lesson.
The five most important things to take from this lesson are the following:
1 - What a Web Page is
A web page is a text document written in a language called HTML. Web browsers read these documents, and then interpret and display them.
2 - How Coding Works
Coding happens when programmers write text in a language that a computer can understand. The computer can then follow the instructions the programmer wrote. For example, the computer might do this by making text like this:
I'm learning to code!
look like this:
I'm learning to code!
3 - Computers are Stupid
Programmers need to write exactly the way a computer understands (also known as writing with correct "syntax").
For example, if you forget to close a b tag, the computer won't be able to figure out what you had intended to make bold. This "stupidity" can be very frustrating, but it also gives programmers incredible power: if you know how to talk to a computer than you can tell it do do anything you want.
4 - Programmers Can't Remember Everything
There are too many details to keep everything in your head. And that's okay. If you forget how to make text italic in HTML, you can always just look it up.
5 - Basic HTML Vocabulary
You will be using HTML in the next few lessons, so it will be helpful if you're comfortable with the jargon.
Tag: An HTML tag is always contained within angled brackets. Most tags have an opening tag ( p for example) and a closing tag, (
). Some tags (called "void" tags) do not require a closing tag (like the br
tag).
Element: An HTML element refers to everything within a set of opening and closing tags.
Attribute: This is a property of an HTML element. For example, to set the href attribute of an anchor tag to the Udacity URL, you would write a href ="udacity.com" p
IMG WITH DOC TYPES
These tags specify type of html docs
doctype html
html
head - meta data javascript css
body tag
end all these tags
Important Concepts
How the Web Works
The web is a bunch of computers that communicate with each other. When a person goes to a web page like www.google.com, their computer sends a HTTP Request to a server. The server finds the appropriate HTML document and sends it back to the user's computer where a web browser interprets the page and displays it on the user's screen. This video does a good job of explaining.
HTML
HTML stands for Hypertext Markup Language. HTML documents form the majority of the content on the web. HTML documents contain text content which describes "what you see" and markup which describes "how it looks". This video gives a good overview.
Tags and Elements
HTML documents are made of HTML elements. When writing HTML, we tell browsers the type of each element by using HTML tags. This video explains the distinction well.
 This makes them very unforgiving since a small mistake by a programmer can cause huge problems in a program.
Inline vs Block Elements
HTML e


{% extends 'base.html'%} {% import 'macros.html' as macro %} {% block styles%} {{ super() }} {% endblock %}
"Pitch ideas on the best things to say to create a good first impression"


The requested resource was not found. Perhaps it was removed or you entered the wrong website address.
If you'd like to go home, please click the button below:
If you believe this is a mistake, feel free to email me:
If all else fails, click the mysterious button below:


TaxEngine
class TaxEngine
Class TaxEngine
Methods
__construct(
Request $request)
No description
addTaxTypeDirectory(
string $namespace,
string $path_to_tax_type_classes)
Add a directroy which contains tax types classes. The tax engine will scan this directory, and add all the tax type classes.
addTaxType(
unknown $fullyQualifiedclassName)
Add a tax type to the current list.
getTaxTypeList()
No description
null|TaxEngine
getDeliveryCountry()
Find Tax Country Id First look for a picked delivery address country Then look at the current customer default address country Else look at the default website country
Details
at line 38
__construct(
Request $request)
at line 53
addTaxTypeDirectory(
string $namespace,
string $path_to_tax_type_classes)
Add a directroy which contains tax types classes. The tax engine will scan this directory, and add all the tax type classes.
at line 64
addTaxType(
unknown $fullyQualifiedclassName)
Add a tax type to the current list.
at line 69
getTaxTypeList()
at line 115
null|TaxEngine
getDeliveryCountry()
Find Tax Country Id First look for a picked delivery address country Then look at the current customer default address country Else look at the default website country


Clint Colding
I like tech, I sometimes play golf, and I can't wait for December 20th.
Welcome to another page
yay
back


Export SEI Data in Alpine CertMetrics Format
Start date:
End date:
Export exam data
Export candidate data
Export item data
Export sect data


Select the work class:
fnlwgt (20000-150000):
age (18-100):
Select the education level:
education years (6 - 16):
hours-per-week (10 - 80):
capital-gain (0 - 80):
capital-loss (0 - 80):
Select the marital status:
Select occupation:
Select relationship:
Select race:
Select sex:
Select native-country:
The value of the option selected is: