KiiCloudStorageSDK : KiiCorp.Cloud.Storage Namespace

KiiTopic Class

Topic on Kii push notification service

Syntax

public class KiiTopic : AccessControllable, KiiSubscribable

Remarks

KiiTopic is entity can be a target sending/subscribe push message.

Requirements

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

Members

See Also: Inherited members from object.

Public Properties

[read-only]
Name string . Gets the name of this instance.
[read-only]
Uri Uri . Gets the URI of this instance

Public Methods

Acl (TopicAction) : KiiTopicACL
Acl the specified action.
Delete ()
Delete the topic.Only the scope owner or topic creator is allowed to perform delete operation.
Delete (KiiTopicCallback)
Asynchronous call for KiiTopic.Delete.
Exists () : bool
Checks whether the topic already exists or not.
Exists (KiiGenericsCallback<Nullable<bool>>)
Asynchronous call for KiiTopic.Exists.
ListAclEntries () : IList<KiiACLEntry<KiiTopic, TopicAction>>
Lists the acl entries of this topic
ListAclEntries (KiiACLListCallback<KiiTopic, TopicAction>)
Asynchronous call for KiiTopic.ListAclEntries.
Save ()
Save this topic on KiiCloud.
Save (KiiTopicCallback)
Asynchronous call of KiiTopic.Save
SendMessage (KiiPushMessage)
Send message to this topic.
SendMessage (KiiPushMessage, KiiPushMessageCallback)
Asynchronous call of KiiTopic.SendMessage(KiiPushMessage)

Member Details

Acl Method

Acl the specified action.

Syntax

public KiiTopicACL Acl (TopicAction action)

Parameters

action
Action.

Returns

ACL of this KiiTopic.

Remarks

Requirements

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

Delete Method

Delete the topic.Only the scope owner or topic creator is allowed to perform delete operation.

Syntax

public void Delete ()

Exceptions

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

Remarks

Requirements

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

Delete Method

Asynchronous call for KiiTopic.Delete.

Syntax

public void Delete (KiiTopicCallback callback)

Parameters

callback
Callback.

Exceptions

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

Remarks

Requirements

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

Exists Method

Checks whether the topic already exists or not.

Syntax

public bool Exists ()

Returns

Documentation for this section has not yet been entered.

Exceptions

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

Remarks

This api sends a request to server.

Requirements

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

Exists Method

Asynchronous call for KiiTopic.Exists.

Syntax

public void Exists (KiiGenericsCallback<Nullable<bool>> callback)

Parameters

callback
Callback.

Exceptions

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

Remarks

This api sends a request to server.

Requirements

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

ListAclEntries Method

Lists the acl entries of this topic

Syntax

Returns

The list of acl entries.

Exceptions

Type Reason
KiiCorp.Cloud.Storage.NotFoundException Is thrown when topic or scope is not in KiiCloud.

Remarks

This api sends a request to server.

Requirements

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

ListAclEntries Method

Asynchronous call for KiiTopic.ListAclEntries.

Syntax

public void ListAclEntries (KiiACLListCallback<KiiTopic, TopicAction> callback)

Parameters

callback
Callback.

Returns

The list of acl entries.

Remarks

This api sends a request to server.

Requirements

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

Name Property

Gets the name of this instance.

Syntax

public string Name { get; }

Value

The name of this instance.

Remarks

Requirements

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

Save Method

Save this topic on KiiCloud.

Syntax

public void Save ()

Exceptions

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

Remarks

Requirements

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

Save Method

Asynchronous call of KiiTopic.Save

Syntax

public void Save (KiiTopicCallback callback)

Parameters

callback
Callback.

Exceptions

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

Remarks

Requirements

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

SendMessage Method

Send message to this topic.

Syntax

public void SendMessage (KiiPushMessage message)

Parameters

message
Message to send.

Exceptions

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

Remarks

Requirements

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

SendMessage Method

Syntax

public void SendMessage (KiiPushMessage message, KiiPushMessageCallback callback)

Parameters

message
Message to send.
callback
Callback.

Exceptions

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

Remarks

Requirements

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

Uri Property

Gets the URI of this instance

Syntax

public Uri Uri { get; }

Value

The URI of this instance.

Remarks

Requirements

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