Class KiiPushSubscription

Represents a KiiPushSubscription.

Hierarchy

KiiPushSubscription

Index

Methods

Methods

isSubscribed

isSubscribed<T>(target: T): Promise<[KiiPushSubscription, T, boolean]>

- Defined in src/push.ts:153
Check subscription of bucket, topic.
example
```
let topic = Kii.topicWithName("myAppTopic");
let user = KiiUser.getCurrentUser();
user.pushSubscription().isSubscribed(topic).then(params => {
  // Succeeded.
  let subscription = params[0];
  let topic = params[1];
  let isSubscribed = params[2];
  if (isSubscribed) {
    // The topic is subscribed by current user.
  } else {
    // The topic is not subscribed by current user.
  }
}).catch(error => {
  // Handle error.
});
```
Type parameters
- T: KiiBucket | KiiTopic
Parameters
- target: T
  
  to check subscription. KiiBucket or KiiTopic instance.
Returns Promise<[KiiPushSubscription, T, boolean]>
return promise object.
- fulfill callback function: function(params). params is an Array instance.
  - params[0] is a KiiPushSubscription instance.
  - params[1] is the instance to subscribe.
  - params[2] is Boolean value. true if subscirbed, otherwise false.
- reject callback function: function(error). error is an Error instance.
  - error.target is a KiiPushSubscription instance.
  - error.message

subscribe

subscribe<T>(target: T): Promise<[KiiPushSubscription, T]>

- Defined in src/push.ts:56
Subscribe to bucket or topic.
example
```
let topic = Kii.topicWithName("myAppTopic");
let user = KiiUser.getCurrentUser();
user.pushSubscription().subscribe(topic).then(params => {
  let subscription = params[0];
  let topic = params[1];
  // Succeeded.
}).catch(error => {
  // Handle error.
});
```
Type parameters
- T: KiiBucket | KiiTopic
Parameters
- target: T
  
  to be subscribed. KiiBucket or KiiTopic instance.
Returns Promise<[KiiPushSubscription, T]>
return promise object.
- fulfill callback function: function(params). params is an Array instance.
  - params[0] is a KiiPushSubscription instance.
  - params[1] is the instance to subscribe.
- reject callback function: function(error). error is an Error instance.
  - error.target is a KiiPushSubscription instance.
  - error.message

unsubscribe

unsubscribe<T>(target: T): Promise<[KiiPushSubscription, T]>

- Defined in src/push.ts:101
Unsubscribe to bucket or topic.
example
```
let topic = Kii.topicWithName("myAppTopic");
let user = KiiUser.getCurrentUser();
user.pushSubscription().unsubscribe(topic).then(params => {
  let subscription = params[0];
  let topic = params[1];
  // Succeeded.
}).catch(error => {
  // Handle error.
});
```
Type parameters
- T: KiiBucket | KiiTopic
Parameters
- target: T
  
  to be unsubscribed. KiiBucket or KiiTopic instance.
Returns Promise<[KiiPushSubscription, T]>
return promise object.
- fulfill callback function: function(params). params is an Array instance.
  - params[0] is a KiiPushSubscription instance.
  - params[1] is the instance to unsubscribe.
- reject callback function: function(error). error is an Error instance.
  - error.target is a KiiPushSubscription instance.
  - error.message

Generated using TypeDoc