NCMBPush Class Reference

Inherits from	NCMBObject : NSObject
Declared in	NCMBPush.h

Overview

NCMBPushは、プッシュ通知の登録・更新・取得・削除を行うクラスです。

Create

`+ push`

NCMBPushのインスタンスを生成

+ (NCMBPush *)push

Return Value

NCMBPushのインスタンス

Declared In

NCMBPush.h

Configuration

`– setTitle:`

プッシュ通知のタイトルを設定(Androidのみ)

- (void)setTitle:(NSString *)title

Parameters

`title`	プッシュ通知のタイトル

Declared In

NCMBPush.h

`– setChannel:`

プッシュ通知を送信するチャネルを設定

- (void)setChannel:(NSString *)channel

Parameters

`channel`	プッシュ通知を送信するチャネル

Declared In

NCMBPush.h

`– setChannels:`

プッシュ通知を送信する複数のチャネルを設定

- (void)setChannels:(NSArray *)channels

Parameters

`channels`	プッシュ通知を送信する複数のチャネルを格納した配列

Declared In

NCMBPush.h

`– setQuery:`

(非推奨:新たに利用する場合はsetSearchConditionを使いましょう) プッシュ通知の配信先となる配信端末を絞り込むためのクエリを設定

- (void)setQuery:(NCMBQuery *)query

Parameters

`query`	プッシュ先を絞り込むためのクエリ

Declared In

NCMBPush.h

`– setSearchCondition:`

プッシュ通知の配信先となる配信端末を絞り込むためのクエリを設定

- (void)setSearchCondition:(NCMBQuery *)query

Parameters

`query`	プッシュ先を絞り込むためのクエリ

Declared In

NCMBPush.h

`– setMessage:`

プッシュ通知のメッセージ内容を設定

- (void)setMessage:(NSString *)message

Parameters

`message`	プッシュ通知のメッセージ内容

Declared In

NCMBPush.h

`– setDialog:`

Android端末でダイアログプッシュ通知を行う設定

- (void)setDialog:(BOOL)dialog

Parameters

`dialog`	ダイアログプッシュ通知を行う場合はtrueを設定。

Declared In

NCMBPush.h

`– setRichUrl:`

リッチプッシュ通知用のURLを設定

- (void)setRichUrl:(NSString *)url

Parameters

`url`	リッチプッシュ通知で表示するWebページのURL

Declared In

NCMBPush.h

`– setPushToAndroid:`

Androidへの配信設定

- (void)setPushToAndroid:(BOOL)pushToAndroid

Parameters

`pushToAndroid`	配信設定。配信する場合はtrueを設定。

Declared In

NCMBPush.h

`– setPushToIOS:`

iOSへの配信設定

- (void)setPushToIOS:(BOOL)pushToIOS

Parameters

`pushToIOS`	配信設定。配信する場合はtrueを設定。

Declared In

NCMBPush.h

`– expireAtDate:`

プッシュ通知の有効期限を設定

- (void)expireAtDate:(NSDate *)date

Parameters

`date`	プッシュ通知の有効期限

Declared In

NCMBPush.h

`– expireAfterTimeInterval:`

プッシュ通知配信日時から設定したインターバル後を有効期限に設定

- (void)expireAfterTimeInterval:(NSString *)timeInterval

Parameters

`timeInterval`	設定できる値は、時間単位で指定する場合は「n hour」(n=1～24）、日単位で指定する場合は「n day」（n=1～28）。

Declared In

NCMBPush.h

`– clearExpiration`

プッシュ通知の有効期限の削除

- (void)clearExpiration

Declared In

NCMBPush.h

`– setUserSettingValue:`

ユーザの情報を設定。開発者が付与したい情報を設定することができる。ここで設定した値はプッシュ通知のペイロードから「com.nifcloud.mbaas.Data」というキーで取得できる

- (void)setUserSettingValue:(NSDictionary *)userSettingValue

Parameters

`userSettingValue`	ユーザの情報

Declared In

NCMBPush.h

`– setDeliveryTime:`

プッシュ通知の配信日時を設定

- (void)setDeliveryTime:(NSDate *)date

Parameters

`date`	プッシュ通知の配信日時

Declared In

NCMBPush.h

`– setImmediateDeliveryFlag:`

即時配信フラグを設定

- (void)setImmediateDeliveryFlag:(BOOL)immediateDeliveryFlag

Parameters

`immediateDeliveryFlag`	即時配信フラグ。即時配信にする場合はYESを設定。デフォルトはYES。

Declared In

NCMBPush.h

`– setBadgeNumber:`

バッジ数を設定(iOSのみ)

- (void)setBadgeNumber:(int)badgeNumber

Parameters

`badgeNumber`	バッジ数

Declared In

NCMBPush.h

`– setBadgeIncrementFlag:`

バッジ数のインクリメント設定

- (void)setBadgeIncrementFlag:(BOOL)badgeIncrementFlag

Parameters

`badgeIncrementFlag`	バッジ数をインクリメントする場合はYESを設定する

Declared In

NCMBPush.h

`– setSound:`

通知音を設定(iOSのみ)

- (void)setSound:(NSString *)soundFileName

Parameters

`soundFileName`	音声ファイル名

Declared In

NCMBPush.h

`– setContentAvailable:`

content-availableを設定(iOSのみ)

- (void)setContentAvailable:(BOOL)contentAvailable

Parameters

`contentAvailable`	content-availableの設定値（真偽値）

Declared In

NCMBPush.h

`– setCategory:`

categoryを設定(iOSのみ)

- (void)setCategory:(NSString *)category

Parameters

`category`	categoryの名前

Declared In

NCMBPush.h

`– setAction:`

actionを設定(Androidのみ)

- (void)setAction:(NSString *)actionName

Parameters

`actionName`	アクション名

Declared In

NCMBPush.h

`– setData:`

プッシュ通知の設定が格納されたNSDictionaryをセットする

- (void)setData:(NSDictionary *)dic

Parameters

`dic`	プッシュ通知の設定

Declared In

NCMBPush.h

Send

`+ sendPushMessageToChannel:withMessage:error:`

指定したチャネルにメッセージのみのプッシュ通知を送信。必要があればエラーをセットし、取得することもできる。

+ (void)sendPushMessageToChannel:(NSString *)channel withMessage:(NSString *)message error:(NSError **)error

Parameters

`channel`	プッシュ先のチャネル
`message`	メッセージ内容
`error`	処理中に起きたエラーのポインタ

Declared In

NCMBPush.h

`+ sendPushMessageToChannelInBackground:withMessage:block:`

指定したチャネルに非同期でメッセージのみのプッシュ通知を送信。登録し終わったら与えられたblockを呼び出す。

+ (void)sendPushMessageToChannelInBackground:(NSString *)channel withMessage:(NSString *)message block:(NCMBErrorResultBlock)block

Parameters

`channel`	プッシュ先のチャネル
`message`	メッセージ内容
`block`	通信後実行されるblock。blockは次の引数のシグネチャを持つ必要がある(NSError *error) errorにはエラーがなければnilが渡される。

Declared In

NCMBPush.h

`+ sendPushMessageToChannelInBackground:withMessage:target:selector:`

指定したチャネルに非同期でメッセージのみのプッシュ通知を送信。取得し終わったら指定されたcallbackを呼び出す。

+ (void)sendPushMessageToChannelInBackground:(NSString *)channel withMessage:(NSString *)message target:(id)target selector:(SEL)selector

Parameters

`channel`	プッシュ先のチャネル
`message`	メッセージ内容
`target`	呼び出すセレクタのターゲット
`selector`	呼び出すセレクタ。次のシグネチャを持つ必要がある。(void)callbackWithResult:(NSNumber )result error:(NSError )error resultには送信完了の有無をNSNumber型で渡される。errorにはエラーがなければnilが渡される。

Declared In

NCMBPush.h

`+ sendPushMessageToQuery:withMessage:error:`

指定したクエリを満たした配信端末にメッセージのみのプッシュ通知を送信。必要があればエラーをセットし、取得することもできる。

+ (void)sendPushMessageToQuery:(NCMBQuery *)query withMessage:(NSString *)message error:(NSError **)error

Parameters

`query`	指定するクエリ
`message`	メッセージ内容
`error`	処理中に起きたエラーのポインタ

Declared In

NCMBPush.h

`+ sendPushMessageToQueryInBackground:withMessage:block:`

指定したクエリを満たした配信端末に非同期でメッセージのみのプッシュ通知を送信。登録し終わったら与えられたblockを呼び出す。

+ (void)sendPushMessageToQueryInBackground:(NCMBQuery *)query withMessage:(NSString *)message block:(NCMBErrorResultBlock)block

Parameters

`query`	指定するクエリ
`message`	メッセージ内容
`block`	通信後実行されるblock。blockは次の引数のシグネチャを持つ必要がある(NSError *error) errorにはエラーがなければnilが渡される。

Declared In

NCMBPush.h

`+ sendPushDataToChannel:withData:error:`

指定したチャネルにプッシュ通知を送信。必要があればエラーをセットし、取得することもできる。

+ (void)sendPushDataToChannel:(NSString *)channel withData:(NSDictionary *)data error:(NSError **)error

Parameters

`channel`	プッシュ先のチャネル
`data`	プッシュ通知内容
`error`	処理中に起きたエラーのポインタ

Declared In

NCMBPush.h

`+ sendPushDataToChannelInBackground:withData:block:`

指定したチャネルに非同期でプッシュ通知を送信。登録し終わったら与えられたblockを呼び出す。

+ (void)sendPushDataToChannelInBackground:(NSString *)channel withData:(NSDictionary *)data block:(NCMBErrorResultBlock)block

Parameters

`channel`	プッシュ先のチャネル
`data`	プッシュ通知内容
`block`	通信後実行されるblock。blockは次の引数のシグネチャを持つ必要がある(NSError *error) errorにはエラーがなければnilが渡される。

Declared In

NCMBPush.h

`+ sendPushDataToChannelInBackground:withData:target:selector:`

指定したチャネルに非同期でプッシュ通知を送信。登録し終わったら指定されたcallbackを呼び出す。

+ (void)sendPushDataToChannelInBackground:(NSString *)channel withData:(NSDictionary *)data target:(id)target selector:(SEL)selector

Parameters

`channel`	プッシュ先のチャネル
`data`	プッシュ通知内容
`target`	呼び出すセレクタのターゲット
`selector`	呼び出すセレクタ。次のシグネチャを持つ必要がある。(void)callbackWithResult:(NSNumber )result error:(NSError )error resultには送信完了の有無をNSNumber型で渡される。errorにはエラーがなければnilが渡される。

Declared In

NCMBPush.h

`+ sendPushDataToQuery:withData:error:`

指定したクエリを満たした配信端末にプッシュ通知を送信。必要があればエラーをセットし、取得することもできる。

+ (void)sendPushDataToQuery:(NCMBQuery *)query withData:(NSDictionary *)data error:(NSError **)error

Parameters

`query`	指定するクエリ
`data`	プッシュ通知内容
`error`	処理中に起きたエラーのポインタ

Declared In

NCMBPush.h

`+ sendPushDataToQueryInBackground:withData:block:`

指定したクエリを満たした配信端末に非同期でプッシュ通知を送信。登録し終わったら与えられたblockを呼び出す。

+ (void)sendPushDataToQueryInBackground:(NCMBQuery *)query withData:(NSDictionary *)data block:(NCMBErrorResultBlock)block

Parameters

`query`	指定するクエリ
`data`	プッシュ通知内容
`block`	通信後実行されるblock。blockは次の引数のシグネチャを持つ必要がある(NSError *error) errorにはエラーがなければnilが渡される。

Declared In

NCMBPush.h

`– sendPush:`

プッシュ通知を送信。必要があればエラーをセットし、取得することができる。

- (void)sendPush:(NSError **)error

Parameters

`error`	処理中に起きたエラーのポインタ

Declared In

NCMBPush.h

`– sendPushInBackgroundWithBlock:`

プッシュ通知を非同期で送信。登録し終わったら与えられたblockを呼び出す。

- (void)sendPushInBackgroundWithBlock:(NCMBErrorResultBlock)block

Parameters

`block`	通信後実行されるblock。blockは次の引数のシグネチャを持つ必要がある(NSError *error) errorにはエラーがなければnilが渡される。

Declared In

NCMBPush.h

`– sendPushInBackgroundWithTarget:selector:`

プッシュ通知を非同期で送信。取得し終わったら指定されたcallbackを呼び出す。

- (void)sendPushInBackgroundWithTarget:(id)target selector:(SEL)selector

Parameters

`target`	呼び出すセレクタのターゲット
`selector`	呼び出すセレクタ。引数として(NSError*)errorオブジェクトを取得できる。

Declared In

NCMBPush.h

Handling

`+ handlePush:`

アプリ起動中にプッシュ通知内容を取得した場合、通知内容を表示する。

+ (void)handlePush:(NSDictionary *)userInfo

Parameters

`userInfo`	プッシュ通知内容

Declared In

NCMBPush.h

`+ handleRichPush:`

アプリ起動中にプッシュ通知内容を取得した場合、Webページを表示する。

+ (void)handleRichPush:(NSDictionary *)userInfo

Parameters

`userInfo`	プッシュ通知内容

Declared In

NCMBPush.h

Query

`+ query`

クラス名を指定してクエリの生成

+ (NCMBQuery *)query

Declared In

NCMBPush.h