Inherits from NSObject
Declared in NBNswBaaSManager.h

Tasks

デリゲート

Other Methods

パーミッションの設定

利用者情報

集計機能

UIApplicationDelegateと対応するAPI

お気に入りランドマーク

取得要求

ランドマーク検索

コンテンツ操作

ビーコン検出

Properties

contentDelegate

コンテンツ用デリゲート

@property (weak) id<NBNswBaaSContentDelegate> contentDelegate

Discussion

コンテンツ用デリゲート

SDKからコンテンツ関連のイベントを受け取るdelegateを設定する。

Declared In

NBNswBaaSManager.h

delegate

デリゲート

@property (weak) id<NBNswBaaSManagerDelegate> delegate

Discussion

デリゲート

SDKからイベントを受け取るdelegateを設定する。

Declared In

NBNswBaaSManager.h

Class Methods

sharedManager

NBNswBaaSManagerインスタンスを取得する。

+ (NBNswBaaSManager *)sharedManager

Return Value

NBNswBaaSManager

Discussion

NBNswBaaSManagerインスタンスを取得する。

Declared In

NBNswBaaSManager.h

Instance Methods

addFavoriteLandmark:

お気に入りランドマークを追加する 【SDKバージョン2.0.0以降】

- (void)addFavoriteLandmark:(NSString *)landmarkId

Parameters

landmarkId

ランドマークID

Discussion

お気に入りランドマークを追加する 【SDKバージョン2.0.0以降】

Declared In

NBNswBaaSManager.h

addFavoriteLandmark:successBlock:failureBlock:

お気に入りランドマークを追加する 【SDKバージョン3.1.0以降】

- (BOOL)addFavoriteLandmark:(NSString *)landmarkId successBlock:(void ( ^ ) ( ))successBlock failureBlock:(void ( ^ ) ( ))failureBlock

Parameters

landmarkId

ランドマークID

successBlock

お気に入りランドマークの追加成功時に呼ばれる

failureBlock

お気に入りランドマークの追加失敗時に呼ばれる

Discussion

お気に入りランドマークを追加する 【SDKバージョン3.1.0以降】

Declared In

NBNswBaaSManager.h

cancelRequestContents:

コンテンツ取得要求をキャンセルする 【SDKバージョン2.0.0以降】

- (void)cancelRequestContents:(NBContentsRequest *)request

Parameters

request

requestContents:にて指定したコンテンツ取得条件

※nilを指定した場合は現在要求中のコンテンツ取得全てをキャンセルする。

Discussion

コンテンツ取得要求をキャンセルする 【SDKバージョン2.0.0以降】

Declared In

NBNswBaaSManager.h

contentsWithRequest:

コンテンツを取得する 【SDKバージョン3.2.0以降】

- (NSArray *)contentsWithRequest:(NBContentsRequest *)request

Parameters

request

コンテンツ取得条件

Return Value

コンテンツ(NBContent)の配列

Discussion

コンテンツを取得する 【SDKバージョン3.2.0以降】

SDKで管理しているコンテンツ情報を取得する(通信によるデータ更新は行わない)。

Declared In

NBNswBaaSManager.h

deleteContents:

コンテンツを削除する 【SDKバージョン2.0.0以降】

- (void)deleteContents:(NSArray *)contentIds

Parameters

contentIds

コンテンツID配列

Discussion

コンテンツを削除する 【SDKバージョン2.0.0以降】

Declared In

NBNswBaaSManager.h

didFailToRegisterForRemoteNotificationsWithError:

RemoteNotification登録失敗時処理 【SDKバージョン2.1.0以降】

- (void)didFailToRegisterForRemoteNotificationsWithError:(NSError *)error

Parameters

error

UIApplicationDelegateのdidFailToRegisterForRemoteNotificationsWithErrorで通知される値

Discussion

RemoteNotification登録失敗時処理 【SDKバージョン2.1.0以降】

UIApplicationDelegateのdidFailToRegisterForRemoteNotificationsWithErrorにて実行すること。

Declared In

NBNswBaaSManager.h

didFinishLaunchingWithOptions:

アプリ起動時処理

- (void)didFinishLaunchingWithOptions:(NSDictionary *)launchOptions

Parameters

launchOptions

UIApplicationDelegateのdidFinishLaunchingWithOptionsで通知される値

Discussion

アプリ起動時処理

UIApplicationDelegateのdidFinishLaunchingWithOptionsにて実行すること。

Declared In

NBNswBaaSManager.h

didReceiveLocalNotification:

LocalNotification受信時処理

- (void)didReceiveLocalNotification:(UILocalNotification *)notification

Parameters

notification

UIApplicationDelegateのdidReceiveLocalNotificationで通知される値

Discussion

LocalNotification受信時処理

UIApplicationDelegateのdidReceiveLocalNotificationにて実行すること。

Declared In

NBNswBaaSManager.h

didReceiveRemoteNotification:

RemoteNotification受信時処理

- (void)didReceiveRemoteNotification:(NSDictionary *)userInfo

Parameters

userInfo

UIApplicationDelegateのdidReceiveRemoteNotificationで通知される値

Discussion

RemoteNotification受信時処理

UIApplicationDelegateのdidReceiveRemoteNotificationにて実行すること。

Declared In

NBNswBaaSManager.h

didRegisterForRemoteNotificationsWithDeviceToken:

RemoteNotification登録完了時処理

- (void)didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)devToken

Parameters

devToken

UIApplicationDelegateのdidRegisterForRemoteNotificationsWithDeviceTokenで通知される値

Discussion

RemoteNotification登録完了時処理

UIApplicationDelegateのdidRegisterForRemoteNotificationsWithDeviceTokenにて実行すること。

Declared In

NBNswBaaSManager.h

favoriteLandmarkIds

お気に入りに追加されているランドマークを取得する 【SDKバージョン2.0.0以降】

- (NSArray *)favoriteLandmarkIds

Return Value

ランドマークIDの配列

Discussion

お気に入りに追加されているランドマークを取得する 【SDKバージョン2.0.0以降】

Declared In

NBNswBaaSManager.h

getClientAppId

ポスモバより発行されたクライアントアプリID(端末個別の識別ID)を取得する。【SDKバージョン3.2.0以降】 クライアント登録が完了していない場合は空文字"“が返る。 @return

- (NSString *)getClientAppId

Discussion

ポスモバより発行されたクライアントアプリID(端末個別の識別ID)を取得する。【SDKバージョン3.2.0以降】 クライアント登録が完了していない場合は空文字"“が返る。 @return

Declared In

NBNswBaaSManager.h

initializeWithSdkId:

初期設定

- (void)initializeWithSdkId:(NSString *)sdkId

Parameters

sdkId

ポスモバWebにて発行されるSDK-ID

Discussion

初期設定

オブジェクト取得後、最初に実行すること。

Declared In

NBNswBaaSManager.h

isDebug

現在のデバッグモードを取得する。

- (BOOL)isDebug

Return Value

true:デバッグモード false:リリースモード

Discussion

現在のデバッグモードを取得する。

Declared In

NBNswBaaSManager.h

isRegistered

クライアント登録済みかを取得する。 【SDKバージョン2.1.0以降】

- (BOOL)isRegistered

Return Value

YES:登録済み NO:未登録

Discussion

クライアント登録済みかを取得する。 【SDKバージョン2.1.0以降】

Declared In

NBNswBaaSManager.h

landmarkWithId:

ランドマークID指定でランドマークを取得する 【SDKバージョン3.1.0以降】

- (NBLandmark *)landmarkWithId:(NSString *)landmarkId

Parameters

landmarkId

ランドマークID

Return Value

ランドマーク

Discussion

ランドマークID指定でランドマークを取得する 【SDKバージョン3.1.0以降】

SDK内部DBから検索。通信での更新確認は行わない。

Declared In

NBNswBaaSManager.h

landmarksWithCode:

ランドマークコード指定でランドマークを取得する 【SDKバージョン3.2.0以降】

- (NSArray *)landmarksWithCode:(NSString *)code

Parameters

code

検索文字列

Return Value

ランドマーク(NBLandmark)の配列

Discussion

ランドマークコード指定でランドマークを取得する 【SDKバージョン3.2.0以降】

SDK内部DBから検索。通信での更新確認は行わない。

Declared In

NBNswBaaSManager.h

landmarksWithDescription:

説明指定でランドマークを取得する※部分一致検索 【SDKバージョン3.1.0以降】

- (NSArray *)landmarksWithDescription:(NSString *)desriptionText

Parameters

desriptionText

検索文字列

Return Value

ランドマーク(NBLandmark)の配列

Discussion

説明指定でランドマークを取得する※部分一致検索 【SDKバージョン3.1.0以降】

SDK内部DBから検索。通信での更新確認は行わない。

Declared In

NBNswBaaSManager.h

landmarksWithLatitude:longitude:area:

指定した位置情報に近いランドマークを取得する 【SDKバージョン3.1.0以降】

- (NSArray *)landmarksWithLatitude:(double)latitude longitude:(double)longitude area:(double)area

Parameters

latitude

緯度

longitude

軽度

area

kNBAreaClose, kNBAreaNear, kNBAreaFarを指定。

Return Value

ランドマーク(NBLandmark)の配列

Discussion

指定した位置情報に近いランドマークを取得する 【SDKバージョン3.1.0以降】

SDK内部DBから検索。通信での更新確認は行わない。 戻り値のリストは距離の順番を保証しない。

Declared In

NBNswBaaSManager.h

landmarksWithName:

名称指定でランドマークを取得する※部分一致検索 【SDKバージョン3.1.0以降】

- (NSArray *)landmarksWithName:(NSString *)name

Parameters

name

検索文字列

Return Value

ランドマーク(NBLandmark)の配列

Discussion

名称指定でランドマークを取得する※部分一致検索 【SDKバージョン3.1.0以降】

SDK内部DBから検索。通信での更新確認は行わない。

Declared In

NBNswBaaSManager.h

landmarksWithTag:

タグ指定でランドマークを取得する 【SDKバージョン3.1.0以降】

- (NSArray *)landmarksWithTag:(NSString *)tag

Parameters

tag

検索文字列

Return Value

ランドマーク(NBLandmark)の配列

Discussion

タグ指定でランドマークを取得する 【SDKバージョン3.1.0以降】

SDK内部DBから検索。通信での更新確認は行わない。

Declared In

NBNswBaaSManager.h

landmarksWithType:

タイプ指定でランドマークを取得する 【SDKバージョン3.2.0以降】

- (NSArray *)landmarksWithType:(NSString *)type

Parameters

type

検索文字列

Return Value

ランドマーク(NBLandmark)の配列

Discussion

タイプ指定でランドマークを取得する 【SDKバージョン3.2.0以降】

SDK内部DBから検索。通信での更新確認は行わない。

Declared In

NBNswBaaSManager.h

locationPermission

SDKのパーミッションを取得する(位置連動配信)。

- (BOOL)locationPermission

Return Value

YES:位置連動配信を使用する NO:位置連動配信を使用しない

Discussion

SDKのパーミッションを取得する(位置連動配信)。

Declared In

NBNswBaaSManager.h

pause

中断処理

- (void)pause

Discussion

中断処理

SDKの処理を中断する。

アプリが中断する際に呼び出すこと。

(UIApplicationDelegateのapplicationDidEnterBackgroundなど)

Declared In

NBNswBaaSManager.h

pushPermission

SDKのパーミッションを取得する(Push通知)。

- (BOOL)pushPermission

Return Value

YES:Push通知を受信する NO:Push通知を受信しない

Discussion

SDKのパーミッションを取得する(Push通知)。

Declared In

NBNswBaaSManager.h

removeFavoriteLandmark:

お気に入りランドマークを削除する 【SDKバージョン2.0.0以降】

- (void)removeFavoriteLandmark:(NSString *)landmarkId

Parameters

landmarkId

ランドマークID

Discussion

お気に入りランドマークを削除する 【SDKバージョン2.0.0以降】

Declared In

NBNswBaaSManager.h

removeFavoriteLandmark:successBlock:failureBlock:

お気に入りランドマークを削除する 【SDKバージョン3.1.0以降】

- (BOOL)removeFavoriteLandmark:(NSString *)landmarkId successBlock:(void ( ^ ) ( ))successBlock failureBlock:(void ( ^ ) ( ))failureBlock

Parameters

landmarkId

ランドマークID

successBlock

お気に入りランドマークの追加成功時に呼ばれる

failureBlock

お気に入りランドマークの追加失敗時に呼ばれる

Discussion

お気に入りランドマークを削除する 【SDKバージョン3.1.0以降】

Declared In

NBNswBaaSManager.h

requestBeacons

ポスモバWebの「ビーコン管理」にて登録した情報を取得する 【SDKバージョン2.0.0以降】

- (void)requestBeacons

Discussion

ポスモバWebの「ビーコン管理」にて登録した情報を取得する 【SDKバージョン2.0.0以降】

取得完了時にNBNswBaaSManagerDelegateプロトコルのdidFinishRequestBeacons:メソッドをコールする

Declared In

NBNswBaaSManager.h

requestContents:

コンテンツ取得要求

- (void)requestContents:(NBContentsRequest *)request

Parameters

request

コンテンツ取得条件(※キャンセル、delegateの引数として扱う)

Discussion

コンテンツ取得要求

取得完了時にNBNswBaaSContentDelegateプロトコルのdidLoadLocalContents:メソッドをコールする

その後、サーバに更新があればdidReceiveUpdateExist:を、なければdidReceiveNoUpdateExist:メソッドをコールする

Declared In

NBNswBaaSManager.h

requestDownloadContentData:

コンテンツ付加データを取得する 【SDKバージョン2.0.0以降】

- (void)requestDownloadContentData:(NSString *)contentId

Parameters

contentId

コンテンツID

Discussion

コンテンツ付加データを取得する 【SDKバージョン2.0.0以降】

取得完了時にNBNswBaaSContentDelegateプロトコルのdidDownloadContentDataInDirectory:メソッドをコールする

Declared In

NBNswBaaSManager.h

requestDownloadLandmarkData:

ランドマーク付加データを取得する 【SDKバージョン2.0.0以降】

- (void)requestDownloadLandmarkData:(NSString *)landmarkId

Parameters

landmarkId

ランドマークID

Discussion

ランドマーク付加データを取得する 【SDKバージョン2.0.0以降】

取得完了時にNBNswBaaSContentDelegateプロトコルのdidDownloadLandmarkDataInDirectory:メソッドをコールする

Declared In

NBNswBaaSManager.h

requestLandmarks

ポスモバWebの「ランドマーク管理」にて登録した情報を取得する。

- (void)requestLandmarks

Discussion

ポスモバWebの「ランドマーク管理」にて登録した情報を取得する。

取得完了時にNBNswBaaSManagerDelegateプロトコルのdidFinishedRequestLandmark:メソッドをコールする

Declared In

NBNswBaaSManager.h

resume

再開処理

- (void)resume

Discussion

再開処理

SDKの処理を再開する。

アプリ再開時に呼び出すこと。

(UIApplicationDelegateのapplicationWillEnterForegroundなど)

Declared In

NBNswBaaSManager.h

sendCounting:landmarkId:beaconId:fieldNo:

集計情報を送信する 【SDKバージョン2.0.0以降】

- (void)sendCounting:(NSString *)cmid landmarkId:(NSString *)landmarkId beaconId:(int)beaconId fieldNo:(NSInteger)fieldNo

Parameters

cmid

メッセージIDまたはコンテンツID

landmarkId

ランドマークID

beaconId

連携機器ID(連携機器に連動したコンテンツでない場合、-1を指定)

fieldNo

集計フィールド(1~5)

Discussion

集計情報を送信する 【SDKバージョン2.0.0以降】

Declared In

NBNswBaaSManager.h

setContentDisable:disable:

コンテンツを無効とする 【SDKバージョン2.0.0以降】

- (BOOL)setContentDisable:(NSString *)contentId disable:(BOOL)disable

Parameters

contentId

コンテンツID

disable

YES:無効 NO:有効

Return Value

NO:引数のcontentIdが存在しない

Discussion

コンテンツを無効とする 【SDKバージョン2.0.0以降】

Declared In

NBNswBaaSManager.h

setContentTmpDisableDate:toDate:

コンテンツを一時的に無効とする 【SDKバージョン2.0.0以降】

- (BOOL)setContentTmpDisableDate:(NSString *)contentId toDate:(NSDate *)tmpDisableDate

Parameters

contentId

コンテンツID

tmpDisableDate

一時無効とする日時

※指定したDateの日時まで一時無効扱いとし、デフォルトのコンテンツ取得方法ではコンテンツを取得されなくする

Return Value

NO:引数のcontentIdが存在しない

Discussion

コンテンツを一時的に無効とする 【SDKバージョン2.0.0以降】

Declared In

NBNswBaaSManager.h

setContentUseCountIncrease:increaseCount:

コンテンツの使用回数を増加させる 【SDKバージョン2.0.0以降】

- (BOOL)setContentUseCountIncrease:(NSString *)contentId increaseCount:(NSInteger)increaseCount

Parameters

contentId

コンテンツID

increaseCount

増加数(マイナス値指定で減少させることも可能)

Return Value

NO:引数のcontentIdが存在しない

Discussion

コンテンツの使用回数を増加させる 【SDKバージョン2.0.0以降】

Declared In

NBNswBaaSManager.h

setDebug:

デバッグモードを設定する。

- (void)setDebug:(BOOL)debug

Parameters

debug

true:デバッグモード false:リリースモード

Discussion

デバッグモードを設定する。

Declared In

NBNswBaaSManager.h

setPermissionPush:location:

SDKのパーミッションを設定する。

- (void)setPermissionPush:(BOOL)usePush location:(BOOL)useLocation

Parameters

usePush

YES:Push通知を受信する NO:Push通知を受信しない

useLocation

YES:位置連動配信を使用する NO:位置連動配信を使用しない

Discussion

SDKのパーミッションを設定する。

Declared In

NBNswBaaSManager.h

setPushMessageAutoPlay:

Push通知受信時、SDKが自動で処理を実行するかを設定する。

- (void)setPushMessageAutoPlay:(BOOL)play

Parameters

play

YES:実行する NO:実行しない

Discussion

Push通知受信時、SDKが自動で処理を実行するかを設定する。

SDKのPush通知受信時処理の内容

  • メッセージの受信状態を"開封済み"とする。

  • URLが指定されている場合は外部ブラウザを起動する。

SDKの位置連動配信受信時処理の内容

  • メッセージの受信状態を"受信済み"とする。

  • 通知センターの通知をタップした後はPush通知受信時処理と同様。

Declared In

NBNswBaaSManager.h

setUserData:data2:data3:data4:data5:

利用者情報を設定する。

- (void)setUserData:(NSString *)data1 data2:(NSString *)data2 data3:(NSString *)data3 data4:(NSString *)data4 data5:(NSString *)data5

Parameters

data1

利用者情報1

data2

利用者情報2

data3

利用者情報3

data4

利用者情報4

data5

利用者情報5

Discussion

利用者情報を設定する。

Declared In

NBNswBaaSManager.h

setUserDataWithArray:

利用者情報を設定する。

- (void)setUserDataWithArray:(NSArray *)datas

Parameters

datas

NSStringを要素とするNSArray

index 0~4 が利用者情報1~5 に対応する。

nilを指定した場合は利用者情報をリセットする。

Discussion

利用者情報を設定する。

Declared In

NBNswBaaSManager.h

sharedBeaconManager

BeaconManagerインスタンスを取得する 【SDKバージョン2.0.0以降】

- (NBBeaconManager *)sharedBeaconManager

Return Value

NBBeaconManager

Discussion

BeaconManagerインスタンスを取得する 【SDKバージョン2.0.0以降】

ビーコンの検出を実施する場合は本メソッドによりインスタンス取得して利用する

※iOS7.0より古いバージョンの場合や、BLE非対応の端末はnilが返る。(BLE利用不可)

Declared In

NBNswBaaSManager.h

userData

利用者情報を取得する。

- (NSArray *)userData

Return Value

NSStringを要素とするNSArray

index 0~4 が利用者情報1~5 に対応する。

Discussion

利用者情報を取得する。

Declared In

NBNswBaaSManager.h