KiiCloudStorageSDK : KiiCorp.Cloud.Storage Namespace

Overview

Signature

Remarks

Members

Member Details

UserFields Class

The User Information except for the Identity Data.

Syntax

public class UserFields : KiiBaseObject

Remarks

Documentation for this section has not yet been entered.

Requirements

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

Members

See Also: Inherited members from KiiBaseObject.

Public Constructors

 Initializes a new instance of the KiiCorp.Cloud.Storage.UserFields class.

Public Properties

 Country string . Gets or sets the country.
Displayname string . Gets or sets the displayname.
[read-only]
 IsEmpty bool . Gets a value indicating whether this instance is empty.
default property
override
Item (string) object . Gets or sets the object with the specified key.
default property
Item (string) object . Gets or sets the object with the specified key. (Inherited from KiiBaseObject.)
Locale LocaleContainer . Gets or sets the locale.

Public Methods

 GetBoolean (string) : bool
Gets the boolean in KiiBaseObject. (Inherited from KiiBaseObject.)
GetBoolean (string, bool) : bool
Gets the boolean. If key is not found, returns fallback. (Inherited from KiiBaseObject.)
GetByteArray (string) : byte[]
Gets the byte array with the specified key. (Inherited from KiiBaseObject.)
GetDouble (string) : double
Gets the double in KiiBaseObject. (Inherited from KiiBaseObject.)
GetDouble (string, double) : double
Gets the double. If key is not found, returns fallback. (Inherited from KiiBaseObject.)
GetInt (string) : int
Gets the integer in KiiBaseObject. (Inherited from KiiBaseObject.)
GetInt (string, int) : int
Gets the integer. If key is not found, returns fallback. (Inherited from KiiBaseObject.)
GetJsonArray (string) : JsonOrg.JsonArray
Gets the Json array with the specified key. (Inherited from KiiBaseObject.)
GetJsonObject (string) : JsonOrg.JsonObject
Gets the JSON object with the specified key. (Inherited from KiiBaseObject.)
GetLong (string) : long
Gets the long in KiiBaseObject. (Inherited from KiiBaseObject.)
GetLong (string, long) : long
Gets the long. If key is not found, returns fallback. (Inherited from KiiBaseObject.)
GetString (string) : string
Gets the string in KiiBaseObject. (Inherited from KiiBaseObject.)
GetString (string, string) : string
Gets the string. If key is not found, returns fallback. (Inherited from KiiBaseObject.)
GetUri (string) : Uri
Gets the Uri with the specified key. (Inherited from KiiBaseObject.)
Has (string) : bool
Determine if this instance has the specified key. (Inherited from KiiBaseObject.)
Keys () : IEnumerable<string>
Gets the list of keys (Inherited from KiiBaseObject.)
override
Remove (string)
Remove the specified key and value.
Remove (string)
Remove the specified key and value. (Inherited from KiiBaseObject.)
RemoveCountry ()
Removes the country from this instance.
RemoveDisplayname ()
Removes the displayname from this instance.
RemoveFromServer (string)
Remove a pair of key/value from UserFields. This pair is also removed from server when KiiUser.Update(IdentityData, UserFields, KiiUserCallback) is succeeded.
RemoveLocale ()
Removes the locale from this instance.

Member Details

UserFields Constructor

Initializes a new instance of the KiiCorp.Cloud.Storage.UserFields class.

Syntax

public UserFields ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

Country Property

Gets or sets the country.

Syntax

public string Country { get; set; }

Value

The country.

Exceptions

Type Reason
ArgumentException Is thrown when an argument is invalid.

Remarks

Country must be valid.

Requirements

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

Displayname Property

Gets or sets the displayname.

Syntax

public string Displayname { get; set; }

Value

The displayname.

Exceptions

Type Reason
ArgumentException Is thrown when an argument is invalid.

Remarks

Display name must be valid.

Requirements

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

IsEmpty Property

Gets a value indicating whether this instance is empty.

Syntax

public bool IsEmpty { get; }

Value

true if this instance is empty; otherwise, false.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

Item Property

Gets or sets the object with the specified key.

Syntax

This is the default property for this class.

public override object this [string key] { get; set; }

Parameters

key
Key.

Value

Value associated with the key.

Exceptions

Type Reason
ArgumentNullException Is thrown when key is null.
KiiCorp.Cloud.Storage.IllegalKiiBaseObjectFormatException Is thrown when specified key is not existed.

Remarks

As the type of value is object, developers need to cast value. If you want to suppress IllegalKiiBaseObjectFormatException, use GetXxx(key, fallback)

Requirements

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

Locale Property

Gets or sets the locale.

Syntax

public LocaleContainer Locale { get; set; }

Value

The locale.

Exceptions

Type Reason
ArgumentException Is thrown when an argument is null.

Remarks

locale must be not null.

Requirements

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

Remove Method

Remove the specified key and value.

Syntax

public override void Remove (string key)

Parameters

key
Key you want to remove

Exceptions

Type Reason
ArgumentException Is thrown when key is empty or reserved.

Remarks

Key must be valid and should not be reserved.

Requirements

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

RemoveCountry Method

Removes the country from this instance.

Syntax

public void RemoveCountry ()

Remarks

Even if you use this method, country is not removed from server.

Requirements

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

RemoveDisplayname Method

Removes the displayname from this instance.

Syntax

public void RemoveDisplayname ()

Remarks

Even if you use this method, display name is not removed from server.

Requirements

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

RemoveFromServer Method

Remove a pair of key/value from UserFields. This pair is also removed from server when KiiUser.Update(IdentityData, UserFields, KiiUserCallback) is succeeded.

Syntax

public void RemoveFromServer (string key)

Parameters

key
Key.

Remarks

KiiCorp.Cloud.Storage.UserFields has a similar method which is UserFields.Remove(string) If you remove fields by UserFields.Remove(string) , pairs are not removed from server. So you can use UserFields.Remove(string) if you want to cancel to update fields which are set in KiiCorp.Cloud.Storage.UserFields.

Requirements

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

RemoveLocale Method

Removes the locale from this instance.

Syntax

public void RemoveLocale ()

Remarks

Even if you use this method, locale is not removed from server.

Requirements

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