API Reference | AIBeaconSDK for iOS

Language

Swift | Objective-CSwift | Objective-C

Class
AIBeaconManager

AIBeaconManager クラスは、 AIBeacon 機能全般を管理します。

AIBeaconManager class manages general AIBeacon functions.

InitializerInstance Method
init(appId:apiKey:)initWithAppId:apiKey:

AIBeaconManager オブジェクトを初期化します。
同時に共有インスタンスが生成されます。共有インスタンスは sharedInstance で取得できます。

Initializes an AIBeaconManager object.
At the same time, it generates sharing instances. instance by using sharedInstance.

AIBeaconManager オブジェクトを初期化します。
同時に共有インスタンスが生成されます。共有インスタンスは sharedInstance() で取得できます。

Initializes an AIBeaconManager object.
At the same time, it generates sharing instances. instance by using sharedInstance().

Declaration

public init?(appId: String, apiKey: String)
- (instancetype _Nullable)initWithAppId:(NSString * _Nonnull)appId apiKey:(NSString * _Nonnull)apiKey;

Parameters

appId NSString *String: 弊社から提供するアプリ ID を設定します。Set App id we provide.
apiKey NSString *String: 弊社から提供する API キーを設定します。Set API key we provide.

Return Value

初期化された AIBeaconManager オブジェクトを返します。Returns an initialized AIBeaconManager object.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.7.1+

Example

var aiBeaconManager: AIBeaconManager? = AIBeaconManager(appId: "[Youra App ID]", apiKey: "[Your API Key]")
AIBeaconManager * aiBeaconManager = [[AIBeaconManager alloc] initWithAppId:@"[Your App ID]" apiKey:@"[Your API Key]"];

InitializerInstance Method
init(appId:apiKey:options:)initWithAppId:apiKey:options:

AIBeaconManager オブジェクトを初期化します。
同時に共有インスタンスが生成されます。共有インスタンスは sharedInstance で取得できます。

Initializes an AIBeaconManager object.
At the same time, it generates sharing instances. instance by using sharedInstance.

AIBeaconManager オブジェクトを初期化します。
同時に共有インスタンスが生成されます。共有インスタンスは sharedInstance() で取得できます。

Initializes an AIBeaconManager object.
At the same time, it generates sharing instances. instance by using sharedInstance().

Declaration

public init?(appId: String, apiKey: String, options: [String: Any]? = nil)
- (instancetype _Nullable)initWithAppId:(NSString * _Nonnull)appId apiKey:(NSString * _Nonnull)apiKey options:(NSDictionary<NSString *, id> * _Nullable)options;

Parameters

appId NSString *String: 弊社から提供するアプリ ID を設定します。Set App id we provide.
apiKey NSString *String: 弊社から提供する API キーを設定します。Set API key we provide.
options NSDictionary<NSString *, id> *[String: Any]: オプションを設定します。
使用できるオプションは AIBeacon Manager Initialization Options を参照下さい。Set Options.
Refer AIBeacon Manager Initialization Options for options you can use.

Return Value

初期化された AIBeaconManager オブジェクトを返します。Returns an initialized AIBeaconManager object.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.7.1+

Example

let options: [String: Any]? = [AIBeaconManagerInitOptionKeysShowBluetoothPowerAlert: true]

var aiBeaconManager: AIBeaconManager? = AIBeaconManager(appId: "[Your App ID]", apiKey: "[Your API Key]", options: options)
NSDictionary<NSString *, id> * options = @{AIBeaconManagerInitOptionKeysShowBluetoothPowerAlert: @(YES)};

AIBeaconManager * aiBeaconManager = [[AIBeaconManager alloc] initWithAppId:@"[Your App ID]" apiKey:@"[Your API Key]" options: options];

Instance PropertyInstance Property
aiBeaconsaiBeacons

AIBeacon 情報リスト。

Information list of the AIBeacons

Declaration

var aiBeacons: [AIContactInfo] { get }
@property (readonly, strong, nonatomic, nonnull) NSArray<AIContactInfo *> * aiBeacons;

Discussion

領域内の AIBeacon 情報のリストを取得します。

You can get the information list of the AIBeacons under the current AIBeaconManager.

Availability

SDK 1.4.0+

Example

let aiBeacons: [AIContactInfo]? = AIBeaconManager.sharedInstance()?.aiBeacons
NSArray<AIContactInfo *> * aiBeacons = [AIBeaconManager sharedInstance].aiBeacons;

Instance PropertyInstance Property
isDebugEnabledisDebugEnabled

デバッグモードの有効／無効を表します。

Indicates whether debug mode is enabled / disabled.

Declaration

var isDebugEnabled: Bool { get }
@property (readonly, assign, nonatomic) BOOL isDebugEnabled;

Discussion

デバッグモードが有効の場合は YES 、無効の場合は NO が設定されます。
このプロパティは読み取り専用です。

It is set to YES if debug mode is enabled, NO if it is disabled.
This property is read-only.

デバッグモードが有効の場合は true 、無効の場合は false が設定されます。
このプロパティは読み取り専用です。

It is set to true if debug mode is enabled, false if it is disabled.
This property is read-only.

Availability

SDK 1.7.0+

Example

let isDebugEnabled: Bool? = AIBeaconManager.sharedInstance()?.isDebugEnabled
BOOL isDebugEnabled = [AIBeaconManager sharedInstance].isDebugEnabled;

Instance PropertyInstance Property
numberOfAIBeaconsnumberOfAIBeacons

AIBeacon 情報の数。

Number of the AIBeacons.

Declaration

var numberOfAIBeacons: Int { get }
@property (readonly, assign, nonatomic) NSInteger numberOfAIBeacons;

Discussion

領域内の AIBeacon 情報の数を取得します。

You can get the number of the AIBeacons under the current AIBeaconManager.

Availability

SDK 1.4.0+

Example

let count: Int? = AIBeaconManager.sharedInstance()?.numberOfAIBeacons
NSInteger count = [AIBeaconManager sharedInstance].numberOfAIBeacons;

Instance MethodInstance Method
receiveNotification(_:)receiveNotificationWithUserInfo:

AIBeacon のプッシュ通知を受信した際の処理を行います。

Handles when the push notification of AIBeacon is received.

Declaration

func receiveNotification(_ userInfo: [AnyHashable: Any]?)
- (void)receiveNotificationWithUserInfo:(NSDictionary * _Nullable)userInfo;

Parameters

userInfo NSDictionary *[AnyHashable: Any]: プッシュ通知のユーザ情報を設定します。Sets the information of the user of the push notification.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.4.0+

Example

func application(_ application: UIApplication, didReceive notification: UILocalNotification) {
    AIBeaconManager.sharedInstance()?.receiveNotification(notification.userInfo)
}

func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable: Any]) {
    AIBeaconManager.sharedInstance()?.receiveNotification(userInfo)
}
- (void)application:(UIApplication *)application didReceiveLocalNotification:(UILocalNotification *)notification {
    [[AIBeaconManager sharedInstance] receiveNotificationWithUserInfo:[notification userInfo]];
}

- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo {
    [[AIBeaconManager sharedInstance] receiveNotificationWithUserInfo:userInfo];
}

Instance MethodInstance Method
registerService()registerService

AIBeacon サービスへの登録を行います。既に登録されている場合は更新が行われます。
AIBeaconManager の初期化後に必ず呼び出して下さい。

Registers to AIBeacon service. If the instance has already registered, it renews the registration.
You need to call it certainly after initializing AIBeaconManager.

Declaration

func registerService()
- (void)registerService;

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.4.0+

Example

// AIBeacon サービスへの登録を行う。
AIBeaconManager.sharedInstance()?.registerService()
// Registers to AIBeacon service.
AIBeaconManager.sharedInstance()?.registerService()
// AIBeacon サービスへの登録を行う。
[[AIBeaconManager sharedInstance] registerService];
// Registers to AIBeacon service.
[[AIBeaconManager sharedInstance] registerService];

Instance MethodInstance Method
requestTracking()requestTracking

iOS 14 以降では、ATT (App Tracking Transparency) 導入に伴い、広告 ID (IDFA) の使用許可要求が必要になったため、許可要求を行うためにこのメソッドを利用します。
メソッド呼び出し後、直接許可要求システムダイアログを表示するか、間に説明ダイアログを表示するかは TrackingDescriptionDialogEnabled オプションの設定で決まります。
また、 iOS 13 以前では、このメソッドを呼び出しても何もしません。

Since iOS 14 and later, with the introduction of ATT (App Tracking Transparency), it is necessary to request permission to use Advertising ID (IDFA), so this method is used to request permission.
Whether to display the permission request system dialog directly after calling the method or the description dialog immediately before is determined by the setting of TrackingDescriptionDialogEnabled option.
Also, in iOS 13 and earlier, calling this method does nothing.

Declaration

func requestTracking()
- (void)requestTracking;

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.9.1+

Example

AIBeaconManager.sharedInstance()?.requestTracking()
AIBeaconManager.sharedInstance()?.requestTracking()
[[AIBeaconManager sharedInstance] requestTracking];
[[AIBeaconManager sharedInstance] requestTracking];

Instance MethodInstance Method
setApnsDeviceToken(_:)setApnsDeviceToken:

APNs のデバイストークンを設定します。
Important下記の全てのオプションに @(YES) を設定することで自動的にデバイストークンの登録を行います。
AIBeaconManagerInitOptionKeysAutoServiceRegistrationEnabled , AIBeaconManagerInitOptionKeysPushNotificationEnabled , AIBeaconManagerInitOptionKeysAppDelegateProxyEnabled

Configures the device token of APNs.
ImportantBy setting @(YES) to all the options below, you can register the device token automatically.
AIBeaconManagerInitOptionKeysAutoServiceRegistrationEnabled , AIBeaconManagerInitOptionKeysPushNotificationEnabled , AIBeaconManagerInitOptionKeysAppDelegateProxyEnabled

APNs のデバイストークンを設定します。
Important下記の全てのオプションに true を設定することで自動的にデバイストークンの登録を行います。
AIBeaconManagerInitOptionKeysAutoServiceRegistrationEnabled , AIBeaconManagerInitOptionKeysPushNotificationEnabled , AIBeaconManagerInitOptionKeysAppDelegateProxyEnabled

Configures the device token of APNs.
ImportantBy setting true to all the options below, you can register the device token automatically.
AIBeaconManagerInitOptionKeysAutoServiceRegistrationEnabled , AIBeaconManagerInitOptionKeysPushNotificationEnabled , AIBeaconManagerInitOptionKeysAppDelegateProxyEnabled

Declaration

func setApnsDeviceToken(_ deviceToken: Data?)
- (void)setApnsDeviceToken:(NSData * _Nullable)deviceToken;

Parameters

deviceToken NSData *Data: APNs のデバイストークンを設定します。Sets the device token of APNs.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.4.0+

Example

func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
    AIBeaconManager.sharedInstance()?.setApnsDeviceToken(deviceToken)
}
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
    [[AIBeaconManager sharedInstance] setApnsDeviceToken:deviceToken];
}

Instance MethodInstance Method
setCustomParameter(_:value:)setCustomParameterWithKey:value:

AIBeacon サーバに送信するカスタムパラメータを設定します。

Sets a custom parameter sending to the AIBeacon server.

Declaration

func setCustomParameter(_ key: String!, value: Any!)
- (void)setCustomParameterWithKey:(NSString * _Nonnull)key value:(id _Nonnull)value;

Parameters

key NSString *String: カスタムパラメータのキーを設定します。Sets the key of the custom parameter.
value idAny: カスタムパラメータの値を設定します。Sets the value of the custom parameter.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.3.0+

Example

AIBeaconManager.sharedInstance()?.setCustomParameter("UserID", 123)
[[AIBeaconManager sharedInstance] setCustomParameterWithKey:@"UserID" value:@(123)];

Instance MethodInstance Method
setCustomParameters(_:)setCustomParameters:

AIBeacon サーバに送信するカスタムパラメータをまとめて設定します。

Configures custom parameters sending to the AIBeacon server at once.

Declaration

func setCustomParameters(_ params: [String: Any]!)
- (void)setCustomParameters:(NSDictionary<NSString *, id> * _Nonnull)params;

Parameters

params NSDictionary<NSString *, id> *[String: Any]: カスタムパラメータのキーと値のペアを設定します。Sets pairs of the key and value of the custom parameter.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.3.0+

Example

AIBeaconManager.sharedInstance()?.setCustomParameters(["UserID": "123",
                                                       "Gender": "female"])
[[AIBeaconManager sharedInstance] setCustomParameters:@{@"UserID": @"123",
                                                        @"Gender": @"female"}];

Instance MethodInstance Method
setDebugEnabled(_:)setDebugEnabled:

デバッグモードを有効にするかどうかを設定します。
デバッグモードを有効にすることで各種デバッグログが出力されるようになります。
デフォルトは無効です。
Importantこのメソッドは AIBeaconManager の初期化後に呼び出して下さい。
AIBeaconManager の初期化時のログも出力したい場合は、 AIBeaconManagerInitOptionKeysDebugEnabled を使用してデバッグモードを有効にして下さい。
また、リリースバージョンのアプリではデバッグモードを有効にしないで下さい。

Enables the debug mode.
Various debug logs will be output by enabling the debug mode.
It is disabled by default.
ImportantThis method should be called after initialization of AIBeaconManager.
If you also want to output the log when initializing AIBeaconManager, please use AIBeaconManagerInitOptionKeysDebugEnabled to enable debug mode.
Please do not enable debug mode in released version of application.

Declaration

func setDebugEnabled(_ enabled: Bool)
- (void)setDebugEnabled:(BOOL)enabled;

Parameters

enabled BOOLBool: 有効にする場合は YES を、無効にする場合は NO を設定します。Set YES if you want to enable, and set NO otherwise.有効にする場合は true を、無効にする場合は false を設定します。Set true if you want to enable, and set false otherwise.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.6.4+

Example

AIBeaconManager.sharedInstance?.setDebugEnabled(true)
[[AIBeaconManager sharedInstance] setDebugEnabled:YES];

Instance MethodInstance Method
setNotificationCloseButtonTitle(_:)setNotificationCloseButtonTitle:

AIBeaconSDK プッシュ通知の標準ポップアップ UI に表示される閉じるボタンのタイトルを設定します。
デフォルトは @"閉じる" です。
ImportantAIBeaconSDKNotificationCloseButtonTitle 、 AIBeaconManagerInitOptionKeysPushNotificationCloseButtonTitle の設定よりも優先されます。

Sets the title of the close button displayed in the standard popup UI for AIBeaconSDK push notification.
The default is @"閉じる" .
ImportantThis takes precedence over the AIBeaconSDKNotificationCloseButtonTitle and AIBeaconManagerInitOptionKeysPushNotificationCloseButtonTitle setting.

AIBeaconSDK プッシュ通知の標準ポップアップ UI に表示される閉じるボタンのタイトルを設定します。
デフォルトは "閉じる" です。
ImportantAIBeaconSDKNotificationCloseButtonTitle 、 AIBeaconManagerInitOptionKeysPushNotificationCloseButtonTitle の設定よりも優先されます。

Sets the title of the close button displayed in the standard popup UI for AIBeaconSDK push notification.
The default is "閉じる" .
ImportantThis takes precedence over the AIBeaconSDKNotificationCloseButtonTitle and AIBeaconManagerInitOptionKeysPushNotificationCloseButtonTitle setting.

Declaration

func setNotificationCloseButtonTitle(_ title: String?)
- (void)setNotificationCloseButtonTitle:(NSString * _Nonnull)title;

Parameters

title NSString *String: ボタンタイトルを設定します。Sets the button title.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.11.5+

Example

AIBeaconManager.sharedInstance()?.setNotificationCloseButtonTitle("CLOSE")
[[AIBeaconManager sharedInstance] setNotificationCloseButtonTitle:@"CLOSE"];

Instance MethodInstance Method
setNotificationDetailButtonTitle(_:)setNotificationDetailButtonTitle:

AIBeaconSDK プッシュ通知の標準ポップアップ UI に表示される詳細ボタンのタイトルを設定します。
デフォルトは @"詳細" です。
ImportantAIBeaconSDKNotificationDetailButtonTitle 、 AIBeaconManagerInitOptionKeysPushNotificationDetailButtonTitle の設定よりも優先されます。

Sets the title of the detail button displayed in the standard popup UI for AIBeaconSDK push notification.
The default is @"詳細" .
ImportantThis takes precedence over the AIBeaconSDKNotificationDetailButtonTitle and AIBeaconManagerInitOptionKeysPushNotificationDetailButtonTitle setting.

AIBeaconSDK プッシュ通知の標準ポップアップ UI に表示される詳細ボタンのタイトルを設定します。
デフォルトは "詳細" です。
ImportantAIBeaconSDKNotificationDetailButtonTitle 、 AIBeaconManagerInitOptionKeysPushNotificationDetailButtonTitle の設定よりも優先されます。

Sets the title of the detail button displayed in the standard popup UI for AIBeaconSDK push notification.
The default is "詳細" .
ImportantThis takes precedence over the AIBeaconSDKNotificationDetailButtonTitle and AIBeaconManagerInitOptionKeysPushNotificationDetailButtonTitle setting.

Declaration

func setNotificationDetailButtonTitle(_ title: String?)
- (void)setNotificationDetailButtonTitle:(NSString * _Nonnull)title;

Parameters

title NSString *String: ボタンタイトルを設定します。Sets the button title.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.11.5+

Example

AIBeaconManager.sharedInstance()?.setNotificationDetailButtonTitle("DETAIL")
[[AIBeaconManager sharedInstance] setNotificationDetailButtonTitle:@"DETAIL"];

Instance MethodInstance Method
setPushNotificationEnabled(_:)setPushNotificationEnabled:

AIBeacon のプッシュ通知機能を有効にするかどうかを設定します。

Configures whether the push notification of AIBeacon is enabled.

Declaration

func setPushNotificationEnabled(_ enabled: Bool)
- (void)setPushNotificationEnabled:(BOOL)enabled;

Parameters

enabled BOOLBool: 有効にする場合は YES を、無効にする場合は NO を設定します。Set YES if you want to enable it, and set NO otherwise.有効にする場合は true を、無効にする場合は false を設定します。Set true if you want to enable it, and set false otherwise.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.4.0+

Example

AIBeaconManager.sharedInstance()?.setPushNotificationEnabled(true)
[[AIBeaconManager sharedInstance] setPushNotificationEnabled:YES];

Instance MethodInstance Method
setServerTransmissionCycleForContactInfoWithSeconds(_:)setServerTransmissionCycleForContactInfoWithSeconds:

AIBeacon 接触情報のサーバ送信周期を設定します。

Sets the server transmission cycle of AIBeacon contact information.

Declaration

func setServerTransmissionCycleForContactInfoWithSeconds(_ seconds: UInt)
- (void)setServerTransmissionCycleForContactInfoWithSeconds:(NSUInteger)seconds;

Parameters

seconds NSUIntegerUInt: サーバ送信周期を秒単位で設定します。
最小値は 15 秒で、それを下回る値は自動的に最小値に置き換わります。
デフォルトは 3600 秒です。Sets the server transmission cycle in seconds.
The minimum value is 15 seconds, and values below it are automatically replaced by the minimum value.
The default is 3600 seconds.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.6.0+

Example

AIBeaconManager.sharedInstance()?.setServerTransmissionCycleForContactInfoWithSeconds(30)
[[AIBeaconManager sharedInstance] setServerTransmissionCycleForContactInfoWithSeconds:30];

Instance MethodInstance Method
setTrackingDescriptionImage(_:)setTrackingDescriptionImage:

ATT (App Tracking Transparency) の説明ダイアログに表示する画像を設定します。
Importantこのメソッドは、必ず requestTracking メソッドより前に呼び出す必要があります。
Info.plist の AIBeaconSDKTrackingDescriptionImage の設定よりも優先されます。

Set the image to be displayed in the ATT (App Tracking Transparency) description dialog.
ImportantThis method must always be called before the requestTracking method.
It takes precedence over the AIBeaconSDKTrackingDescriptionImage setting in Info.plist.

Declaration

func setTrackingDescriptionImage(_ image: UIImage?)
- (void)setTrackingDescriptionImage:(UIImage * _Nullable)image;

Parameters

params UIImage *UIImage?: 説明ダイアログに表示する画像を設定します。Set the image to be displayed in the description dialog.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.9.1+

Example

AIBeaconManager.sharedInstance()?.setTrackingDescriptionImage(UIImage(named: "image_name"))
[[AIBeaconManager sharedInstance] setTrackingDescriptionImage:[UIImage imageNamed:@"image_name"]];

Instance MethodInstance Method
setUseIdfaEnabled(_:)setUseIdfaEnabled:

IDFA の収集を有効にするかどうかを設定します。
デフォルトは有効です。
Important有効にする場合は、 AdSupport.framework をプロジェクトに追加する必要があります。
iOS 14 以降の場合は、 AppTrackingTransparency.framework もプロジェクトに追加する必要があります。
Note~~enableUseIDFA:~~ is renamed to setUseIdfaEnabled: since SDK 1.6.2.

Enables the collect of IDFA.
It is enabled by default.
ImportantIf you want to enable it, you need to add AdSupport.framework to your project.
For iOS 14 and above, you also need to add AppTrackingTransparency.framework to your project.
Note~~enableUseIDFA:~~ is renamed to setUseIdfaEnabled: since SDK 1.6.2.

IDFA の収集を有効にするかどうかを設定します。
デフォルトは有効です。
Important有効にする場合は、 AdSupport.framework をプロジェクトに追加する必要があります。
iOS 14 以降の場合は、 AppTrackingTransparency.framework もプロジェクトに追加する必要があります。
Note~~enableUseIDFA(_:)~~ is renamed to setUseIdfaEnabled(_:) since SDK 1.6.2.

Enables the collect of IDFA.
It is enabled by default.
ImportantIf you want to enable it, you need to add AdSupport.framework to your project.
For iOS 14 and above, you also need to add AppTrackingTransparency.framework to your project.
Note~~enableUseIDFA(_:)~~ is renamed to setUseIdfaEnabled(_:) since SDK 1.6.2.

Declaration

func setUseIdfaEnabled(_ enabled: Bool)
- (void)setUseIdfaEnabled:(BOOL)enabled;

Parameters

enabled BOOLBool: 有効にする場合は YES を、無効にする場合は NO を設定します。Set YES if you want to enable, and set NO otherwise.有効にする場合は true を、無効にする場合は false を設定します。Set true if you want to enable, and set false otherwise.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.0.0+

Example

AIBeaconManager.sharedInstance?.setUseIdfaEnabled(true)
[[AIBeaconManager sharedInstance] setUseIdfaEnabled:YES];

Type MethodType Method
sharedInstance()sharedInstance

AIBeaconManager の共有インスタンスを返します。

Returns a shared instance of AIBeaconManager.

Declaration

class func sharedInstance() -> AIBeaconManager?
+ (AIBeaconManager * _Nullable)sharedInstance;

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.0.0+

Example

let aiBeaconManager: AIBeaconManager? = AIBeaconManager.sharedInstance()
AIBeaconManager * aiBeaconManager = [AIBeaconManager sharedInstance];

Instance MethodInstance Method
startAiBeaconMonitoring()startAiBeaconMonitoring

AIBeacon の領域監視を開始します。

Starts monitoring of AIBeacon.

Declaration

func startAiBeaconMonitoring()
- (void)startAiBeaconMonitoring;

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.0.1+

Example

AIBeaconManager.sharedInstance()?.startAiBeaconMonitoring()
[[AIBeaconManager sharedInstance] startAiBeaconMonitoring];

Instance MethodInstance Method
stopAiBeaconMonitoring()stopAiBeaconMonitoring

AIBeacon の領域監視を停止します。

Stops monitoring of AIBeacon.

Declaration

func stopAiBeaconMonitoring()
- (void)stopAiBeaconMonitoring;

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.10.1+

Example

AIBeaconManager.sharedInstance()?.stopAiBeaconMonitoring()
[[AIBeaconManager sharedInstance] stopAiBeaconMonitoring];

Protocol
AIBeaconManagerDelegate

AIBeaconManager オブジェクトのデリゲートに、 AIBeacon サービスへの登録結果や、AIBeacon 領域への進入、退出、測距の状況などを伝えるメソッドを定義します。

This delegate of an AIBeaconManager object defines methods which get the result of registration to the AIBeacon service and status of entrance, exit, and distance measurement for the target region of AIBeacons.

Instance MethodInstance Method
aiBeaconManagerRegisterServiceSucceeded(_:)aiBeaconManagerRegisterServiceSucceeded:

AIBeacon サービスへの登録または更新が成功したことをデリゲートに伝えます。
Note~~aiBeaconManagerRegisterDeviceSucceeded:~~ is renamed to aiBeaconManagerRegisterServiceSucceeded: since SDK 1.4.0.

Tells the success of a registration to the AIBeacon service or the renewal of the registration to the delegate.
Note~~aiBeaconManagerRegisterDeviceSucceeded:~~ is renamed to aiBeaconManagerRegisterServiceSucceeded: since SDK 1.4.0.

AIBeacon サービスへの登録または更新が成功したことをデリゲートに伝えます。
Note~~aiBeaconManagerRegisterDeviceSucceeded(_:)~~ is renamed to aiBeaconManagerRegisterServiceSucceeded(_:) since SDK 1.4.0.

Tells the success of a registration to the AIBeacon service or the renewal of the registration to the delegate.
Note~~aiBeaconManagerRegisterDeviceSucceeded(_:)~~ is renamed to aiBeaconManagerRegisterServiceSucceeded(_:) since SDK 1.4.0.

Declaration

optional public func aiBeaconManagerRegisterServiceSucceeded(_ aiBeaconManager: AIBeaconManager)
@optional - (void)aiBeaconManagerRegisterServiceSucceeded:(AIBeaconManager * _Nonnull)aiBeaconManager;

Parameters

aiBeaconManager AIBeaconManager *AIBeaconManager: AIBeaconManager オブジェクトを設定します。Sets your AIBeaconManager object.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.0.0+

Example

func aiBeaconManagerRegisterServiceSucceeded(_ aiBeaconManager: AIBeaconManager) {
    // AIBeacon サービスへの登録または更新が成功した。
}
func aiBeaconManagerRegisterServiceSucceeded(_ aiBeaconManager: AIBeaconManager) {
    // The registration to the AIBeacon service or its renewal succeeded.
}
- (void)aiBeaconManagerRegisterServiceSucceeded:(AIBeaconManager *)aiBeaconManager {
    // AIBeacon サービスへの登録または更新が成功した。
}
- (void)aiBeaconManagerRegisterServiceSucceeded:(AIBeaconManager *)aiBeaconManager {
    // The registration to the AIBeacon service or its renewal succeeded.
}

Instance MethodInstance Method
aiBeaconManager(_:didEnterRegionOfAiBeacon:)aiBeaconManager:didEnterRegionOfAiBeacon:

AIBeacon の領域に入ったことをデリゲートに伝えます。
Note~~aiBeaconManager:enterRegion:~~ is renamed to aiBeaconManager:didEnterRegionOfAiBeacon: since SDK 1.5.0.

Tells the entrance to the region of the AIBeacons to the delegate.
Note~~aiBeaconManager:enterRegion:~~ is renamed to aiBeaconManager:didEnterRegionOfAiBeacon: since SDK 1.5.0.

AIBeacon の領域に入ったことをデリゲートに伝えます。
Note~~aiBeaconManager(_:enterRegion:)~~ is renamed to aiBeaconManager(_:didEnterRegionOfAiBeacon:) since SDK 1.5.0.

Tells the entrance to the region of the AIBeacons to the delegate.
Note~~aiBeaconManager(_:enterRegion:)~~ is renamed to aiBeaconManager(_:didEnterRegionOfAiBeacon:) since SDK 1.5.0.

Declaration

optional func aiBeaconManager(_ aiBeaconManager: AIBeaconManager, didEnterRegionOfAiBeacon aiBeacon: AIContactInfo?)
@optional - (void)aiBeaconManager:(AIBeaconManager * _Nonnull)aiBeaconManager didEnterRegionOfAiBeacon:(AIContactInfo * _Nullable)aiBeacon;

Parameters

aiBeaconManager AIBeaconManager *AIBeaconManager: AIBeaconManager オブジェクトを設定します。Sets your AIBeaconManager object.
aiBeacon AIContactInfo *AIContactInfo: AIBeacon の接触情報を設定します。Sets the information of the AIBeacons.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.0.0+

Example

func aiBeaconManager(_ aiBeaconManager: AIBeaconManager, didEnterRegionOfAiBeacon aiBeacon: AIContactInfo?) {
    NSLog("Enter the region: Unit ID = \(aiBeacon?.unitId ?? "")")
}
- (void)aiBeaconManager:(AIBeaconManager *)aiBeaconManager didEnterRegionOfAiBeacon:(AIContactInfo *)aiBeacon {
    NSLog(@"Enter the region: Unit ID = %@", aiBeacon.unitId);
}

Instance MethodInstance Method
aiBeaconManager(_:didExitRegionOfAiBeacon:)aiBeaconManager:didExitRegionOfAiBeacon:

AIBeacon の領域から出たことをデリゲートに伝えます。
Note~~aiBeaconManager:exitRegion:~~ is renamed to aiBeaconManager:didExitRegionOfAiBeacon: since SDK 1.5.0.

Tells the exit from the region of the AIBeacons to the delegate.
Note~~aiBeaconManager:exitRegion:~~ is renamed to aiBeaconManager:didExitRegionOfAiBeacon: since SDK 1.5.0.

AIBeacon の領域から出たことをデリゲートに伝えます。
Note~~aiBeaconManager(_:exitRegion:)~~ is renamed to aiBeaconManager(_:didExitRegionOfAiBeacon:) since SDK 1.5.0.

Tells the exit from the region of the AIBeacons to the delegate.
Note~~aiBeaconManager(_:exitRegion:)~~ is renamed to aiBeaconManager(_:didExitRegionOfAiBeacon:) since SDK 1.5.0.

Declaration

optional func aiBeaconManager(_ aiBeaconManager: AIBeaconManager, didExitRegionOfAiBeacon aiBeacon: AIContactInfo?)
@optional - (void)aiBeaconManager:(AIBeaconManager * _Nonnull)aiBeaconManager didExitRegionOfAiBeacon:(AIContactInfo * _Nullable)aiBeacon;

Parameters

aiBeaconManager AIBeaconManager *AIBeaconManager: AIBeaconManager オブジェクトを設定します。Sets your AIBeaconManager object.
aiBeacon AIContactInfo *AIContactInfo: AIBeacon の接触情報を設定します。Sets the information of the AIBeacons.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.0.0+

Example

func aiBeaconManager(_ aiBeaconManager: AIBeaconManager, didExitRegionOfAiBeacon aiBeacon: AIContactInfo?) {
    NSLog("Exit the region: Unit ID = \(aiBeacon.unitId ?? "")")
}
- (void)aiBeaconManager:(AIBeaconManager *)aiBeaconManager didExitRegionOfAiBeacon:(AIContactInfo *)aiBeacon {
    NSLog(@"Exit the region: Unit ID = %@", aiBeacon.unitId);
}

Instance MethodInstance Method
aiBeaconManager(_:didRangeAiBeacons:)aiBeaconManager:didRangeAiBeacons:

AIBeacon の測距中の間、継続的に測距中であることをデリゲートに伝えます。
Note~~aiBeaconManager:ranging:~~ is renamed to aiBeaconManager:didRangeAiBeacons: since SDK 1.5.0.

Tells the AIBeacons are measuring distances to the delegate.
Note~~aiBeaconManager:ranging:~~ is renamed to aiBeaconManager:didRangeAiBeacons: since SDK 1.5.0.

AIBeacon の測距中の間、継続的に測距中であることをデリゲートに伝えます。
Note~~aiBeaconManager(_:ranging:)~~ is renamed to aiBeaconManager(_:didRangeAiBeacons:) since SDK 1.5.0.

Tells the AIBeacons are measuring distances to the delegate.
Note~~aiBeaconManager(_:ranging:)~~ is renamed to aiBeaconManager(_:didRangeAiBeacons:) since SDK 1.5.0.

Declaration

optional func aiBeaconManager(_ aiBeaconManager: AIBeaconManager, didRangeAiBeacons aiBeacons: [AIContactInfo]?)
@optional - (void)aiBeaconManager:(AIBeaconManager * _Nonnull)aiBeaconManager didRangeAiBeacons:(NSArray<AIContactInfo *> * _Nullable)aiBeacons;

Parameters

aiBeaconManager AIBeaconManager *AIBeaconManager: AIBeaconManager オブジェクトを設定します。Sets your AIBeaconManager object.
aiBeacons NSArray<AIContactInfo *> *[AIContactInfo]: AIBeacon の接触情報リストを設定します。Sets the information list of the AIBeacons.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.0.0+

Example

func aiBeaconManager(_ aiBeaconManager: AIBeaconManager, didRangeAiBeacons aiBeacons: [AIContactInfo]?) {
    for i: Int in 0..<(aiBeacons?.count ?? 0) {
        NSLog("Ranging: AIBeacon info #\(i) = \(aiBeacons![i].description)")
    }
}
- (void)aiBeaconManager:(AIBeaconManager *)aiBeaconManager didRangeAiBeacons:(NSArray<AIContactInfo *> *)aiBeacons {
    for (int i = 0; i < aiBeacons.count; i++) {
        NSLog(@"Ranging: AIBeacon info #%d = %@", i, aiBeacons[i]);
    }
}

Instance MethodInstance Method
aiBeaconManager(_:registerServiceFailed:)aiBeaconManager:registerServiceFailed:

AIBeacon サービスへの登録または更新が失敗したことをデリゲートに伝えます。
Note~~aiBeaconManager:registerDeviceFailed:~~ is renamed to aiBeaconManager:registerServiceFailed: since SDK 1.4.0.

Tells the failure of a registration to the AIBeacon service or the renewal of the registration to the delegate.
Note~~aiBeaconManager:registerDeviceFailed:~~ is renamed to aiBeaconManager:registerServiceFailed: since SDK 1.4.0.

AIBeacon サービスへの登録または更新が失敗したことをデリゲートに伝えます。
Note~~aiBeaconManager(_:registerDeviceFailed:)~~ is renamed to aiBeaconManager(_:registerServiceFailed:) since SDK 1.4.0.

Tells the failure of a registration to the AIBeacon service or the renewal of the registration to the delegate.
Note~~aiBeaconManager(_:registerDeviceFailed:)~~ is renamed to aiBeaconManager(_:registerServiceFailed:) since SDK 1.4.0.

Declaration

optional public func aiBeaconManager(_ aiBeaconManager: AIBeaconManager, registerServiceFailed errorMessage: String?)
- (void)aiBeaconManager:(AIBeaconManager * _Nonnull)aiBeaconManager registerServiceFailed:(NSString * _Nullable)errorMessage;

Parameters

aiBeaconManager AIBeaconManager *AIBeaconManager: AIBeaconManager オブジェクトを設定します。Sets your AIBeaconManager object.
errorMessage NSString *String?: エラーメッセージを設定します。Sets an error message.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.0.0+

Example

func aiBeaconManager(_ aiBeaconManager: AIBeaconManager, registerServiceFailed errorMessage: String?) {
    // AIBeacon サービスへの登録または更新が失敗した。
    NSLog("Error message = \(errorMessage)")
}
func aiBeaconManager(_ aiBeaconManager: AIBeaconManager, registerServiceFailed errorMessage: String?) {
    // The registration to the AIBeacon service or its renewal failed.
    NSLog("Error message = \(errorMessage)")
}
- (void)aiBeaconManager:(AIBeaconManager *)aiBeaconManager registerServiceFailed:(NSString *)errorMessage {
    // AIBeacon サービスへの登録または更新が失敗した。
    NSLog(@"Error message = %@", errorMessage);
}
- (void)aiBeaconManager:(AIBeaconManager *)aiBeaconManager registerServiceFailed:(NSString *)errorMessage {
    // The registration to the AIBeacon service or its renewal failed.
    NSLog(@"Error message = %@", errorMessage);
}

Instance MethodInstance Method
aiBeaconManager(_:shouldContactNotificationInquiryOfAiBeacon:)aiBeaconManager:shouldContactNotificationInquiryOfAiBeacon:

AIBeacon 接触プッシュで配信するプッシュ通知メッセージがあるか確認するべきかどうかをデリゲートに伝えます。

Tell the delegate if you need to check for push notification messages delivered by AIBeacon's contact push.

AIBeacon 接触プッシュで配信するプッシュ通知メッセージがあるか確認するべきかどうかをデリゲートに伝えます。

Tell the delegate if you need to check for push notification messages delivered by AIBeacon's contact push.

Declaration

optional func aiBeaconManager(_ aiBeaconManager: AIBeaconManager, shouldContactNotificationInquiryOfAiBeacon aiBeacon: AIContactInfo?) -> Bool
@optional - (BOOL)aiBeaconManager:(AIBeaconManager * _Nonnull)aiBeaconManager shouldContactNotificationInquiryOfAiBeacon:(AIContactInfo * _Nullable)aiBeacon;

Parameters

aiBeaconManager AIBeaconManager *AIBeaconManager: AIBeaconManager オブジェクトを設定します。Sets your AIBeaconManager object.
aiBeacon AIContactInfo *AIContactInfo: AIBeacon の接触情報を設定します。Sets the information of the AIBeacons.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.9.1+

Example

func aiBeaconManager(_ aiBeaconManager: AIBeaconManager, shouldContactNotificationInquiryOfAiBeacon aiBeacon: AIContactInfo?) -> Bool {
    // AIBeacon 接触プッシュで配信するプッシュ通知メッセージがあるか確認する直前に呼び出されます。
    // 配信するプッシュ通知メッセージがあるか確認しない場合は、return に false を返します。
    return true
}
func aiBeaconManager(_ aiBeaconManager: AIBeaconManager, shouldContactNotificationInquiryOfAiBeacon aiBeacon: AIContactInfo?) -> Bool {
    // Called just before checking for push notification messages to be delivered by AIBeacon's contact push.
    // If you do not want to see if there are push notification messages to deliver, return true.
    return true
}
- (BOOL)aiBeaconManager:(AIBeaconManager *)aiBeaconManager shouldContactNotificationInquiryOfAiBeacon:(AIContactInfo *)aiBeacon {
    // AIBeacon 接触プッシュで配信するプッシュ通知メッセージがあるか確認する直前に呼び出されます。
    // 配信するプッシュ通知メッセージがあるか確認しない場合は、return に NO を返します。
    return YES;
}
- (BOOL)aiBeaconManager:(AIBeaconManager *)aiBeaconManager shouldContactNotificationInquiryOfAiBeacon:(AIContactInfo *)aiBeacon {
    // Called just before checking for push notification messages to be delivered by AIBeacon's contact push.
    // If you do not want to see if there are push notification messages to deliver, return NO.
    return YES;
}

Instance MethodInstance Method
aiBeaconManager(_:willReceiveNotification:)aiBeaconManager:willReceiveNotification:

AIBeacon のプッシュ通知を受信することをデリゲートに伝えます。
バックグラウンドで接触プッシュ (ローカル通知) を受信した際に呼び出されます。
ImportantSDK 1.11.3 までは、 AINotificationData の title しか受け取ることができませんでした。
SDK 1.11.4 以降、 AINotificationData の全てのデータを受け取れるようになりました。

Tells the delegate to receive the push notifications of the AIBeacons.
It is called when a contact push (local notification) is received in the background.
ImportantUp until SDK 1.11.3, you could only receive the title of AINotificationData .
From SDK 1.11.4 onwards, you can receive all data of AINotificationData .

Declaration

optional func aiBeaconManager(_ aiBeaconManager: AIBeaconManager, willReceiveNotification notificationData: AINotificationData?) -> Bool
@optional - (BOOL)aiBeaconManager:(AIBeaconManager * _Nonnull)aiBeaconManager willReceiveNotification:(AINotificationData * _Nullable)notificationData;

Parameters

aiBeaconManager AIBeaconManager *AIBeaconManager: AIBeaconManager オブジェクトを設定します。Sets your AIBeaconManager object.
notificationData AINotificationData *AINotificationData?: AIBeacon のプッシュ通知情報を設定します。Sets the data of the push notification of AIBeacon.

Return Value

YES を返す場合はローカル通知を表示し、 NO を返す場合は表示しません。
デフォルトは YES を返します。If the return value is YES, the device shows the local notification. If the value is YES, the device doesn't show the local notification.
The value is YES by default.true を返す場合はローカル通知を表示し、 false を返す場合は表示しません。
デフォルトは true を返します。If the return value is true, the device shows the local notification. If the value is false, the device doesn't show the local notification.
The value is true by default.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.2.0+

Example

func aiBeaconManager(_ aiBeaconManager: AIBeaconManager, willReceiveNotification notificationData: AINotificationData?) -> Bool {
    // AIBeacon のプッシュ通知を受信する直前に呼ばれます。
    // ローカル通知を表示したくない場合は、return に false を返します。
    return true
}
func aiBeaconManager(_ aiBeaconManager: AIBeaconManager, willReceiveNotification notificationData: AINotificationData?) -> Bool {
    // Called just before the delegate receives the push notification of AIBeacon.
    // If you don't like to show the local notification, return false.
    return true
}
- (BOOL)aiBeaconManager:(AIBeaconManager *)aiBeaconManager willReceiveNotification:(AINotificationData *)notificationData {
    // AIBeacon のプッシュ通知を受信する直前に呼ばれます。
    // ローカル通知を表示したくない場合は、return に NO を返します。
    return YES;
}
- (BOOL)aiBeaconManager:(AIBeaconManager *)aiBeaconManager willReceiveNotification:(AINotificationData *)notificationData {
    // Called just before the delegate receives the push notification of AIBeacon.
    // If you don't like to show the local notification, return NO.
    return YES;
}

Instance MethodInstance Method
aiBeaconManager(_:willShowNotificationMessage:)aiBeaconManager:willShowNotificationMessage:

AIBeacon のプッシュ通知メッセージを表示することをデリゲートに伝えます。

Tells the delegate to show the push notification message of AIBeacon.

Declaration

optional func aiBeaconManager(_ aiBeaconManager: AIBeaconManager, willShowNotificationMessage notificationData: AINotificationData?) -> Bool
@optional - (BOOL)aiBeaconManager:(AIBeaconManager * _Nonnull)aiBeaconManager willShowNotificationMessage:(AINotificationData * _Nullable)notificationData;

Parameters

aiBeaconManager AIBeaconManager *AIBeaconManager: AIBeaconManager オブジェクトを設定します。Sets your AIBeaconManager object.
notificationData AINotificationData *AINotificationData?: AIBeacon のプッシュ通知情報を設定します。Sets the data of the push notification of AIBeacon.

Return Value

YES を返す場合は AIBeaconSDK プッシュ通知の標準ポップアップ UI を表示し、 NO を返す場合は表示しません。
デフォルトは YES を返します。If the return value is YES, the app shows the standard popup UI for AIBeaconSDK push notification. If the value is NO, the app doesn't show the standard popup UI.
Returns YES by default.true を返す場合は AIBeaconSDK プッシュ通知の標準ポップアップ UI を表示し、 false を返す場合は表示しません。
デフォルトは true を返します。If the return value is true, the app shows the standard popup UI for AIBeaconSDK push notification. If the value is false, the app doesn't show the standard popup UI.
Returns true by default.

Import Statement

import AIBeaconSDK
@import AIBeaconSDK;

Availability

SDK 1.2.0+

Example

func aiBeaconManager(_ aiBeaconManager: AIBeaconManager, willShowNotificationMessage notificationData: AINotificationData?) -> Bool {
    // AIBeacon のプッシュ通知メッセージを表示する直前に呼ばれます。
    // AIBeaconSDK プッシュ通知の標準 ポップアップ UI を表示したくない場合は、return に false を返します。
    return true
}
func aiBeaconManager(_ aiBeaconManager: AIBeaconManager, willShowNotificationMessage notificationData: AINotificationData?) -> Bool {
    // Called just before showing the push notification message of AIBeacon.
    // If you do not want to display the standard popup UI for AIBeaconSDK push notification, return false.
    return true
}
- (BOOL)aiBeaconManager:(AIBeaconManager *)aiBeaconManager willShowNotificationMessage:(AINotificationData *)notificationData {
    // AIBeacon のプッシュ通知メッセージを表示する直前に呼ばれます。
    // AIBeaconSDK プッシュ通知の標準 ポップアップ UI を表示したくない場合は、return に NO を返します。
    return YES;
}
- (BOOL)aiBeaconManager:(AIBeaconManager *)aiBeaconManager willShowNotificationMessage:(AINotificationData *)notificationData {
    // Called just before showing the push notification message of AIBeacon.
    // If you do not want to display the standard popup UI for AIBeaconSDK push notification, return NO.
    return YES;
}

AIBeacon Manager Initialization Options

AIBeaconManager にオプションを設定するために使用するキー。

The key for configuring the options of AIBeaconManager.

Global VariableGlobal Variable
AIBeaconManagerInitOptionKeysAppDelegateProxyEnabledAIBeaconManagerInitOptionKeysAppDelegateProxyEnabled

Declaration

public let AIBeaconManagerInitOptionKeysAppDelegateProxyEnabled: String
NSString * _Nonnull const AIBeaconManagerInitOptionKeysAppDelegateProxyEnabled;

Discussion

UIApplicationDelegate の処理を SDK 側に委ねるかどうか (以下 AppDelegateProxy と呼ぶ) を BOOL 型をラップした NSNumber の値で指定します。
キーの値が @(YES) の場合は AppDelegateProxy が有効になり、 @(NO) の場合は無効になります。
AppDelegateProxy を無効にした場合は、プッシュ通知関連の一部処理をアプリ側で実装する必要があります。
キーが指定されてない場合のデフォルト値は @(YES) です。
ImportantAppDelegateProxy が有効の場合は、 Method Swizzling により以下のデリゲートメソッドの実装が入れ替わります。
その為、入れ替え前のメソッド内の self が指すオブジェクトが AIBeaconManager オブジェクトになるのでご注意下さい。
self を使用している場合は、全て [UIApplication sharedApplication].delegate に置き換えるか、オプションに @(NO) を設定して AppDelegateProxy を無効にして下さい。
UIApplicationDelegate#application:didRegisterUserNotificationSettings: , UIApplicationDelegate#application:didRegisterForRemoteNotificationsWithDeviceToken: , UIApplicationDelegate#application:didFailToRegisterForRemoteNotificationsWithError: , UIApplicationDelegate#application:didReceiveLocalNotification: , UIApplicationDelegate#application:didReceiveRemoteNotification:

Specify with BOOL value wrapped with NSNumber for this key whether to delegate processing of UIApplicationDelegate to the SDK side (hereinafter referred to as AppDelegateProxy).
If value of this key is @(YES), AppDelegateProxy is enabled, and if @(NO) it is disabled.
If you disable AppDelegateProxy, you need to implement a part of tasks about the push notification.
Value of this key is @(YES) by default.
ImportantIn the case where AppDelegateProxy is enabled, Method Swizzling alters the implementations below.
Note that self in the method before altering indicates the AIBeaconManager object because of it.
If you are using self, replace it with [UIApplication sharedApplication].delegate or disable AppDelegateProxy by setting @(NO) as an option.
UIApplicationDelegate#application:didRegisterUserNotificationSettings: , UIApplicationDelegate#application:didRegisterForRemoteNotificationsWithDeviceToken: , UIApplicationDelegate#application:didFailToRegisterForRemoteNotificationsWithError: , UIApplicationDelegate#application:didReceiveLocalNotification: , UIApplicationDelegate#application:didReceiveRemoteNotification:

UIApplicationDelegate の処理を SDK 側に委ねるかどうか (以下 AppDelegateProxy と呼ぶ) を Bool 型の値で指定します。
キーの値が true の場合は AppDelegateProxy が有効になり、 false の場合は無効になります。
AppDelegateProxy を無効にした場合は、プッシュ通知関連の一部処理をアプリ側で実装する必要があります。
キーが指定されてない場合のデフォルト値は true です。
ImportantAppDelegateProxy が有効の場合は、Method Swizzling により以下のデリゲートメソッドの実装が入れ替わります。
その為、入れ替え前のメソッド内の self が指すオブジェクトが AIBeaconManager オブジェクトになるのでご注意下さい。
self を使用している場合は、全て UIApplication.shared.delegate に置き換えるか、オプションに false を設定して AppDelegateProxy を無効にして下さい。
UIApplicationDelegate#application(_:didRegister:) , UIApplicationDelegate#application(_:didRegisterForRemoteNotificationsWithDeviceToken:) , UIApplicationDelegate#application(_:didFailToRegisterForRemoteNotificationsWithError:) , UIApplicationDelegate#application:application(_:didReceive:) , UIApplicationDelegate#application(_:didReceiveRemoteNotification:)

Specify with Bool value for this key whether to delegate processing of UIApplicationDelegate to the SDK side (hereinafter referred to as AppDelegateProxy).
If value of this key is true, AppDelegateProxy is enabled, and if false it is disabled.
If you disable AppDelegateProxy, you need to implement a part of tasks about the push notification.
Value of this key is true by default.
ImportantIn the case where AppDelegateProxy is enabled, Method Swizzling alters the implementations below.
Note that self in the method before altering indicates the AIBeaconManager object because of it.
If you are using self, replace it with UIApplication.shared.delegate or disable AppDelegateProxy by setting false as an option.
UIApplicationDelegate#application(_:didRegister:) , UIApplicationDelegate#application(_:didRegisterForRemoteNotificationsWithDeviceToken:) , UIApplicationDelegate#application(_:didFailToRegisterForRemoteNotificationsWithError:) , UIApplicationDelegate#application:application(_:didReceive:) , UIApplicationDelegate#application(_:didReceiveRemoteNotification:)

Availability

SDK 1.4.0+

Global VariableGlobal Variable
AIBeaconManagerInitOptionKeysAppLaunchOptionsAIBeaconManagerInitOptionKeysAppLaunchOptions

Declaration

public let AIBeaconManagerInitOptionKeysAppLaunchOptions: String
NSString * _Nonnull const AIBeaconManagerInitOptionKeysAppLaunchOptions;

Discussion

アプリの起動が完了した際 ( UIApplicationDelegate#application(_:didFinishLaunchingWithOptions:) ) の launchOptions を設定します。
プッシュ通知からアプリを起動した際の処理を行うために使用されるので、 AIBeacon のプッシュ通知機能を有効にした場合は必ず設定して下さい。

Set an argument launchOptions of ( UIApplicationDelegate#application(_:didFinishLaunchingWithOptions:) ) when the start-up of the app is done.
Set it surely if the push notification of AIBeacon is enabled because it is used when the push notification starts the app.

アプリの起動が完了した際 ( UIApplicationDelegate#application:didFinishLaunchingWithOptions: ) の launchOptions を設定します。
プッシュ通知からアプリを起動した際の処理を行うために使用されるので、 AIBeacon のプッシュ通知機能を有効にした場合は必ず設定して下さい。

Set an argument launchOptions of ( UIApplicationDelegate#application:didFinishLaunchingWithOptions: ) when the start-up of the app is done.
Set it surely if the push notification of AIBeacon is enabled because it is used when the push notification starts the app.

Availability

SDK 1.4.0+

Global VariableGlobal Variable
AIBeaconManagerInitOptionKeysAutoServiceRegistrationEnabledAIBeaconManagerInitOptionKeysAutoServiceRegistrationEnabled

Declaration

public let AIBeaconManagerInitOptionKeysAutoServiceRegistrationEnabled: String
NSString * _Nonnull const AIBeaconManagerInitOptionKeysAutoServiceRegistrationEnabled;

Discussion

AIBeacon サービスへの登録を自動で行うかどうか (以下自動サービス登録と呼ぶ) を BOOL 型をラップした NSNumber の値で指定します。
キーの値が @(YES) の場合は自動サービス登録が有効になり、 @(NO) の場合は無効になります。
キーが指定されてない場合のデフォルト値は @(NO) です。
Importantこのキーの値に @(NO) を設定した場合は、 AIBeaconManager 初期化後に registerService を呼び出す必要があります。

Specify with BOOL value wrapped with NSNumber for this key whether the registration to the AIBeacon service is automated (hereinafter referred to as automated service registration).
If value of this key is @(YES), the automated service registration is enabled, and if @(NO) it is disabled.
Value of this key is @(NO) by default.
ImportantIn the case where the key is set to @(NO), you need to call registerService after initializing AIBeaconManager.

AIBeacon サービスへの登録を自動で行うかどうか (以下自動サービス登録と呼ぶ) を Bool 型の値で指定します。
キーの値が true の場合は自動サービス登録が有効になり、 false の場合は無効になります。
キーが指定されてない場合のデフォルト値は false です。
Importantこのキーの値に false を設定した場合は、 AIBeaconManager 初期化後に registerService() を呼び出す必要があります。

Specify with Bool value for this key whether the registration to the AIBeacon service is automated (hereinafter referred to as automated service registration).
If value of this key is true, the automated service registration is enabled, and if false it is disabled.
Value of this key is false by default.
ImportantIn the case where the key is set to false, you need to call registerService() after initializing AIBeaconManager.

Availability

SDK 1.4.0+

Global VariableGlobal Variable
AIBeaconManagerInitOptionKeysBluetoothMonitoringEnabledAIBeaconManagerInitOptionKeysBluetoothMonitoringEnabled

Declaration

public let AIBeaconManagerInitOptionKeysBluetoothMonitoringEnabled: String
NSString * _Nonnull const AIBeaconManagerInitOptionKeysBluetoothMonitoringEnabled;

Discussion

Bluetooth 設定を監視するかどうかを BOOL 型をラップした NSNumber の値で指定します。
キーの値が @(YES) の場合は Bluetooth 設定を監視し、 @(NO) の場合は監視しません。
キーが指定されてない場合のデフォルト値は @(YES) です。
@(YES) の場合は、Bluetooth On/Off による AIBeacon スキャンの開始／停止を自動的に制御します。
また、初期化処理直後に Bluetooth の許可要求システムダイアログが表示されます。(iOS 13 以降)

Specifies whether to monitor Bluetooth settings with the value of NSNumber wrapped around the BOOL type.
If the key value is @(YES), it monitors the Bluetooth settings, and if it is @(NO), it does not.
Value of this key is @(YES) by default.
If @(YES), it automatically controls the start / stop of AIBeacon scan by Bluetooth On / Off.
Also, the Bluetooth permission request system dialog is displayed immediately after the initialization process. (iOS 13 or later)

Bluetooth 設定を監視するかどうかを Bool 型の値で指定します。
キーの値が true の場合は Bluetooth 設定を監視し、 false の場合は監視しません。
キーが指定されてない場合のデフォルト値は true です。
true の場合は、Bluetooth On/Off による AIBeacon スキャンの開始／停止を自動的に制御します。
また、初期化処理直後に Bluetooth の許可要求システムダイアログが表示されます。(iOS 13 以降)

Specifies whether to monitor Bluetooth settings with the value of Bool type.
If the key value is true, it monitors the Bluetooth settings, and if it is false, it does not.
Value of this key is true by default.
If true, it automatically controls the start / stop of AIBeacon scan by Bluetooth On / Off.
Also, the Bluetooth permission request system dialog is displayed immediately after the initialization process. (iOS 13 or later)

Availability

SDK 1.10.1+

Global VariableGlobal Variable
AIBeaconManagerInitOptionKeysDebugEnabledAIBeaconManagerInitOptionKeysDebugEnabled

Declaration

public let AIBeaconManagerInitOptionKeysDebugEnabled: String
NSString * _Nonnull const AIBeaconManagerInitOptionKeysDebugEnabled;

Discussion

デバッグモードを有効にするかどうかを BOOL 型をラップした NSNumber の値で指定します。
キーの値が @(YES) の場合はデバッグモードが有効になり、 @(NO) の場合は無効になります。
キーが指定されてない場合のデフォルト値は @(NO) です。
Importantリリースバージョンのアプリではデバッグモードを有効にしないで下さい。

Specify with BOOL value wrapped with NSNumber for this key whether to enable debug mode.
If value of this key is @(YES), debug mode is enabled, and if @(NO) it is disabled.
Value of this key is @(NO) by default.
ImportantPlease do not enable debug mode in released version of application.

デバッグモードを有効にするかどうかを Bool 型の値で指定します。
キーの値が true の場合はデバッグモードが有効になり、 false の場合は無効になります。
キーが指定されてない場合のデフォルト値は false です。
Importantリリースバージョンのアプリではデバッグモードを有効にしないで下さい。

Specify with Bool value for this key whether to enable debug mode.
If value of this key is true, debug mode is enabled, and if false it is disabled.
Value of this key is false by default.
ImportantPlease do not enable debug mode in released version of application.

Availability

SDK 1.6.4+

Global VariableGlobal Variable
AIBeaconManagerInitOptionKeysPushNotificationCloseButtonTitleAIBeaconManagerInitOptionKeysPushNotificationCloseButtonTitle

Declaration

public let AIBeaconManagerInitOptionKeysPushNotificationCloseButtonTitle: String
NSString * _Nonnull const AIBeaconManagerInitOptionKeysPushNotificationCloseButtonTitle;

Discussion

AIBeaconSDK プッシュ通知の標準ポップアップ UI に表示される閉じるボタンのタイトルを設定します。
デフォルトは @"閉じる" です。
ImportantAIBeaconSDKNotificationCloseButtonTitle の設定よりも優先されます。

AIBeaconSDK プッシュ通知の標準ポップアップ UI に表示される閉じるボタンのタイトルを設定します。
デフォルトは "閉じる" です。
ImportantAIBeaconSDKNotificationCloseButtonTitle の設定よりも優先されます。

Availability

SDK 1.11.5+

Global VariableGlobal Variable
AIBeaconManagerInitOptionKeysPushNotificationDetailButtonTitleAIBeaconManagerInitOptionKeysPushNotificationDetailButtonTitle

Declaration

public let AIBeaconManagerInitOptionKeysPushNotificationDetailButtonTitle: String
NSString * _Nonnull const AIBeaconManagerInitOptionKeysPushNotificationDetailButtonTitle;

Discussion

AIBeaconSDK プッシュ通知の標準ポップアップ UI に表示される詳細ボタンのタイトルを設定します。
デフォルトは @"詳細" です。
ImportantAIBeaconSDKNotificationDetailButtonTitle の設定よりも優先されます。

AIBeaconSDK プッシュ通知の標準ポップアップ UI に表示される詳細ボタンのタイトルを設定します。
デフォルトは "詳細" です。
ImportantAIBeaconSDKNotificationDetailButtonTitle の設定よりも優先されます。

Availability

SDK 1.11.5+

Global VariableGlobal Variable
AIBeaconManagerInitOptionKeysPushNotificationEnabledAIBeaconManagerInitOptionKeysPushNotificationEnabled

Declaration

public let AIBeaconManagerInitOptionKeysPushNotificationEnabled: String
NSString * _Nonnull const AIBeaconManagerInitOptionKeysPushNotificationEnabled;

Discussion

AIBeacon のプッシュ通知機能を有効にするかどうかを BOOL 型をラップした NSNumber の値で指定します。
キーの値が @(YES) の場合はプッシュ通知機能が有効になり、 @(NO) の場合は無効になります。
キーが指定されてない場合のデフォルト値は @(NO) です。
Importantこのキーの値に @(YES) を設定した場合は、 AIBeaconManager 初期化後にプッシュ通知の初期化処理が自動で行われます。
プッシュ通知の初期化処理を任意のタイミングで行いたい場合は、オプションの値には @(NO) を設定し、 setPushNotificationEnabled:YES でプッシュ通知機能を有効にして下さい。

Specify with BOOL value wrapped with NSNumber for this key whether to enable the push notification function of AIBeacon.
If value of this key is @(YES), the push notification function of AIBeacon is enabled, and if @(NO) it is disabled.
Value of this key is @(NO) by default.
ImportantIf you set @(YES) to the key, the push notification is initialized automatically after initializing AIBeaconManager.
If you want to initialize the push notification at any time you like, you need to set @(NO) to this option and enable the push notification by using setPushNotificationEnabled:YES.

AIBeacon のプッシュ通知機能を有効にするかどうかを Bool 型の値で指定します。
キーの値が true の場合はプッシュ通知機能が有効になり、 false の場合は無効になります。
キーが指定されてない場合のデフォルト値は false です。
Importantこのキーの値に true を設定した場合は、 AIBeaconManager 初期化後にプッシュ通知の初期化処理が自動で行われます。
プッシュ通知の初期化処理を任意のタイミングで行いたい場合は、オプションの値には false を設定し、 setPushNotificationEnabled(true) でプッシュ通知機能を有効にして下さい。

Specify with Bool value for this key whether to enable the push notification function of AIBeacon.
If value of this key is true, the push notification function of AIBeacon is enabled, and if false it is disabled.
Value of this key is false by default.
ImportantIf you set true to the key, the push notification is initialized automatically after initializing AIBeaconManager.
If you want to initialize the push notification at any time you like, you need to set false to this option and enable the push notification by using setPushNotificationEnabled(true).

Availability

SDK 1.4.0+

Global VariableGlobal Variable
AIBeaconManagerInitOptionKeysRequestLocationServiceAuthorizationTypeAIBeaconManagerInitOptionKeysRequestLocationServiceAuthorizationType

Declaration

public let AIBeaconManagerInitOptionKeysRequestLocationServiceAuthorizationType: String
NSString * _Nonnull const AIBeaconManagerInitOptionKeysRequestLocationServiceAuthorizationType;

Discussion

位置情報サービスのアクセス範囲を AIBeaconRequestLocationServiceAuthorizationType 型の値で指定します。
キーの値が AIBeaconRequestLocationServiceAuthorizationTypeAlways の場合は位置情報サービスの利用を常に許可し、 AIBeaconRequestLocationServiceAuthorizationTypeWhenInUse の場合はアプリ使用中のみ許可します。
キーが指定されてない場合のデフォルト値は AIBeaconRequestLocationServiceAuthorizationTypeAlways です。
Note~~AIBeaconManagerInitOptionRequestLocationServiceAuthorizationTypeKey~~ is renamed to AIBeaconManagerInitOptionKeysRequestLocationServiceAuthorizationType since SDK 1.4.0.
ImportantAIBeaconRequestLocationServiceAuthorizationTypeWhenInUse を設定した場合は Info.plist に NSLocationWhenInUseUsageDescription を追加する必要があります。
iOS 11 以降でも常に許可に対応するには NSLocationAlwaysAndWhenInUseUsageDescription を追加する必要があります。

Choose the authorization level of AIBeaconManager for the location service by AIBeaconRequestLocationServiceAuthorizationType value.
If value of this key is AIBeaconRequestLocationServiceAuthorizationTypeAlways AIBeaconManager can always use the location service, and if AIBeaconRequestLocationServiceAuthorizationTypeWhenInUse it is can use only when the user is using the app.
Value of this key is AIBeaconRequestLocationServiceAuthorizationTypeAlways by default.
Note~~AIBeaconManagerInitOptionRequestLocationServiceAuthorizationTypeKey~~ is renamed to AIBeaconManagerInitOptionKeysRequestLocationServiceAuthorizationType since SDK 1.4.0.
ImportantYou need add NSLocationWhenInUseUsageDescription to your Info.plist in the case where AIBeaconRequestLocationServiceAuthorizationTypeWhenInUse is set.
On iOS 11 and later, you need add NSLocationAlwaysAndWhenInUseUsageDescription for always allow.

位置情報サービスのアクセス範囲を AIBeaconRequestLocationServiceAuthorizationType 型の rawValue の値で指定します。
キーの値が AIBeaconRequestLocationServiceAuthorizationType.always.rawValue の場合は位置情報サービスの利用を常に許可し、 AIBeaconRequestLocationServiceAuthorizationType.whenInUse.rawValue の場合はアプリ使用中のみ許可します。
キーが指定されてない場合のデフォルト値は AIBeaconRequestLocationServiceAuthorizationType.always.rawValue です。
Note~~AIBeaconManagerInitOptionRequestLocationServiceAuthorizationTypeKey~~ is renamed to AIBeaconManagerInitOptionKeysRequestLocationServiceAuthorizationType since SDK 1.4.0.
ImportantAIBeaconRequestLocationServiceAuthorizationType.whenInUse.rawValue を設定した場合は Info.plist に NSLocationWhenInUseUsageDescription を追加する必要があります。
iOS 11 以降でも常に許可に対応するには NSLocationAlwaysAndWhenInUseUsageDescription を追加する必要があります。

Choose the authorization level of AIBeaconManager for the location service by rawValue value of AIBeaconRequestLocationServiceAuthorizationType.
If value of this key is AIBeaconRequestLocationServiceAuthorizationType.always.rawValue AIBeaconManager can always use the location service, and if AIBeaconRequestLocationServiceAuthorizationType.whenInUse.rawValue it is can use only when the user is using the app.
Value of this key is AIBeaconRequestLocationServiceAuthorizationType.always.rawValue by default.
Note~~AIBeaconManagerInitOptionRequestLocationServiceAuthorizationTypeKey~~ is renamed to AIBeaconManagerInitOptionKeysRequestLocationServiceAuthorizationType since SDK 1.4.0.
ImportantYou need add NSLocationWhenInUseUsageDescription to your Info.plist in the case where AIBeaconRequestLocationServiceAuthorizationType.whenInUse.rawValue is set.
On iOS 11 and later, you need add NSLocationAlwaysAndWhenInUseUsageDescription for always allow.

Availability

SDK 1.2.1+

Global VariableGlobal Variable
AIBeaconManagerInitOptionKeysShowBluetoothPowerAlertAIBeaconManagerInitOptionKeysShowBluetoothPowerAlert

Declaration

public let AIBeaconManagerInitOptionKeysShowBluetoothPowerAlert: String
NSString * _Nonnull const AIBeaconManagerInitOptionKeysShowBluetoothPowerAlert;

Discussion

端末の Bluetooth がオフの状態で initWithAppId:apiKey: または initWithAppId:apiKey:options: を呼び出した場合に、アラートダイアログを表示するかどうかを BOOL 型をラップした NSNumber の値で指定します。
キーの値が @(YES) の場合はアラートダイアログが表示され、 @(NO) の場合は表示されません。
キーが指定されてない場合のデフォルト値は @(NO) です。
Note~~AIBeaconManagerInitOptionIsShowBluetoothPowerAlertKey~~ is renamed to AIBeaconManagerInitOptionKeysShowBluetoothPowerAlert since SDK 1.4.0.

Specify with BOOL value wrapped with NSNumber for this key whether the device shows an alert dialog in the case where initWithAppId:apiKey: or initWithAppId:apiKey:options: is called when the Bluetooth of the device is turned off.
If value of this key is @(YES) the device shows an alert dialog, and it doesn't show otherwise.
Value of this key is @(NO) by default.
Note~~AIBeaconManagerInitOptionIsShowBluetoothPowerAlertKey~~ is renamed to AIBeaconManagerInitOptionKeysShowBluetoothPowerAlert since SDK 1.4.0.

端末の Bluetooth がオフの状態で init(appId:apiKey:) または init(appId:apiKey:options:) を呼び出した場合に、アラートダイアログを表示するかどうかを Bool 型の値で指定します。
キーの値が true の場合はアラートダイアログが表示され、 false の場合は表示されません。
キーが指定されてない場合のデフォルト値は false です。
Note~~AIBeaconManagerInitOptionIsShowBluetoothPowerAlertKey~~ is renamed to AIBeaconManagerInitOptionKeysShowBluetoothPowerAlert since SDK 1.4.0.

Specify with Bool value for this key whether the device shows an alert dialog in the case where init(appId:apiKey:) or init(appId:apiKey:options:) is called when the Bluetooth of the device is turned off.
If value of this key is true the device shows an alert dialog, and it doesn't show otherwise.
Value of this key is false by default.
Note~~AIBeaconManagerInitOptionIsShowBluetoothPowerAlertKey~~ is renamed to AIBeaconManagerInitOptionKeysShowBluetoothPowerAlert since SDK 1.4.0.

Availability

SDK 1.1.0+

Global VariableGlobal Variable
AIBeaconManagerInitOptionKeysTrackingDescriptionDialogEnabledAIBeaconManagerInitOptionKeysTrackingDescriptionDialogEnabled

Declaration

public let AIBeaconManagerInitOptionKeysTrackingDescriptionDialogEnabled: String
NSString * _Nonnull const AIBeaconManagerInitOptionKeysTrackingDescriptionDialogEnabled;

Discussion

ATT (App Tracking Transparency) の許可要求システムダイアログを表示する前に、
説明ダイアログを表示するかどうかを BOOL 型をラップした NSNumber の値で指定します。
キーの値が @(YES) の場合は説明ダイアログを表示し、 @(NO) の場合は表示しません。
キーが指定されてない場合のデフォルト値は @(NO) です。

Before displaying the ATT (App Tracking Transparency) permission request system dialog,
specify whether to display the description dialog with the value of NSNumber that wraps the BOOL type.
If the key value is @(YES), the description dialog is displayed, and if it is @(NO), it is not displayed.
Value of this key is @(NO) by default.

ATT (App Tracking Transparency) の許可要求システムダイアログを表示する前に、
説明ダイアログを表示するかどうかを Bool 型の値で指定します。
キーの値が true の場合は説明ダイアログを表示し、 false の場合は表示しません。
キーが指定されてない場合のデフォルト値は false です。

Before displaying the ATT (App Tracking Transparency) permission request system dialog,
specify whether to display the description dialog with the value of Bool type.
If the key value is true, the description dialog is displayed, and if it is false, it is not displayed.
Value of this key is false by default.

Availability

SDK 1.9.1+

Global VariableGlobal Variable
AIBeaconManagerInitOptionKeysUseIdfaEnabledAIBeaconManagerInitOptionKeysUseIdfaEnabled

Declaration

public let AIBeaconManagerInitOptionKeysUseIdfaEnabled: String
NSString * _Nonnull const AIBeaconManagerInitOptionKeysUseIdfaEnabled;

Discussion

IDFA の収集を有効にするかどうかを BOOL 型をラップした NSNumber の値で指定します。
キーの値が @(YES) の場合は IDFA の収集が有効になり、 @(NO) の場合は無効になります。
キーが指定されてない場合のデフォルト値は @(YES) です。
Important有効にする場合は、 AdSupport.framework をプロジェクトに追加する必要があります。
iOS 14 以降の場合は、 AppTrackingTransparency.framework もプロジェクトに追加する必要があります。

Specify with BOOL value wrapped with NSNumber for this key whether to enable collect of IDFA.
If value of this key is @(YES), collect of IDFA is enabled, and if @(NO) it is disabled.
Value of this key is @(YES) by default.
ImportantIf you want to enable it, you need to add AdSupport.framework to your project.
For iOS 14 and above, you also need to add AppTrackingTransparency.framework to your project.

IDFA の収集を有効にするかどうかを Bool 型の値で指定します。
キーの値が true の場合は IDFA の収集が有効になり、 false の場合は無効になります。
キーが指定されてない場合のデフォルト値は true です。
Important有効にする場合は、 AdSupport.framework をプロジェクトに追加する必要があります。
iOS 14 以降の場合は、 AppTrackingTransparency.framework もプロジェクトに追加する必要があります。

Specify with Bool value for this key whether to enable collect of IDFA.
If value of this key is true, collect of IDFA is enabled, and if false it is disabled.
Value of this key is true by default.
ImportantIf you want to enable it, you need to add AdSupport.framework to your project.
For iOS 14 and above, you also need to add AppTrackingTransparency.framework to your project.

Availability

SDK 1.6.2+

AIBeacon Manager Notifications

AIBeaconManager が行う通知。

Notifications of AIBeconManager.

Global VariableGlobal Variable
AIBeaconManagerEnterRegionAIBeaconManagerEnterRegionNotification

Declaration

static let AIBeaconManagerEnterRegion: NSNotification.Name
NSString * const AIBeaconManagerEnterRegionNotification;

Discussion

AIBeacon の領域に入った際に通知されます。

Notifies the entrance of AIBeacon's region.

Availability

SDK 1.0.0+

Global VariableGlobal Variable
AIBeaconManagerExitRegionAIBeaconManagerExitRegionNotification

Declaration

static let AIBeaconManagerExitRegion: NSNotification.Name
NSString * const AIBeaconManagerExitRegionNotification;

Discussion

AIBeacon の領域から出た際に通知されます。

Notifies the exit of AIBeacon's region.

Availability

SDK 1.0.0+

Global VariableGlobal Variable
AIBeaconManagerRangingAIBeaconManagerRangingNotification

Declaration

static let AIBeaconManagerRanging: NSNotification.Name
NSString * const AIBeaconManagerRangingNotification;

Discussion

AIBeacon の測距中の間、継続的に通知されます。

Tells the AIBeacon's are measuring distances.

Availability

SDK 1.0.0+

Global VariableGlobal Variable
AIBeaconManagerRegisterServiceFailedAIBeaconManagerRegisterServiceFailedNotification

Note~~AIBeaconManagerRegisterDeviceFailedNotification~~ is renamed to
AIBeaconManagerRegisterServiceFailedNotification since SDK 1.4.0.

Note~~AIBeaconManagerRegisterDeviceFailed~~ is renamed to
AIBeaconManagerRegisterServiceFailed since SDK 1.4.0.

Declaration

static let AIBeaconManagerRegisterServiceFailed: NSNotification.Name
NSString * const AIBeaconManagerRegisterServiceFailedNotification;

Discussion

AIBeacon サービスへの登録または更新が失敗したことを通知します。

Notifies the registration of AIBeacon service or its renewal fails.

Availability

SDK 1.0.0+

Example

// AIBeacon サービスへの登録／更新失敗通知を設定する。
NotificationCenter.default.addObserver(self, selector: #selector(self.aiBeaconManagerRegisterServiceFailed(_:)), name: NSNotification.Name.AIBeaconManagerRegisterServiceFailed, object: nil)
// Confitures the notification of failure of the registration to the AIBeacon service or its renewal.
NotificationCenter.default.addObserver(self, selector: #selector(self.aiBeaconManagerRegisterServiceFailed(_:)), name: NSNotification.Name.AIBeaconManagerRegisterServiceFailed, object: nil)
// AIBeacon サービスへの登録／更新失敗通知を設定する。
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(aiBeaconManagerRegisterServiceFailed:) name:AIBeaconManagerRegisterServiceFailedNotification object:nil];
// Confitures the notification of failure of the registration to the AIBeacon service or its renewal.
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(aiBeaconManagerRegisterServiceFailed:) name:AIBeaconManagerRegisterServiceFailedNotification object:nil];

Global VariableGlobal Variable
AIBeaconManagerRegisterServiceSucceededAIBeaconManagerRegisterServiceSucceededNotification

Note~~AIBeaconManagerRegisterDeviceSucceededNotification~~ is renamed to
AIBeaconManagerRegisterServiceSucceededNotification since SDK 1.4.0.

Note~~AIBeaconManagerRegisterDeviceSucceeded~~ is renamed to
AIBeaconManagerRegisterServiceSucceeded since SDK 1.4.0.

Declaration

static let AIBeaconManagerRegisterServiceSucceeded: NSNotification.Name
NSString * const AIBeaconManagerRegisterServiceSucceededNotification;

Discussion

AIBeacon サービスへの登録または更新が成功したことを通知します。

Notifies the registration of AIBeacon service or its renewal succeeds.

Availability

SDK 1.0.0+

Example

// AIBeacon サービスへの登録／更新成功通知を設定する。
NotificationCenter.default.addObserver(self, selector: #selector(self.aiBeaconManagerRegisterServiceSucceeded(_:)), name: NSNotification.Name.AIBeaconManagerRegisterServiceSucceeded, object: nil)
// Confitures the notification of success of the registration to the AIBeacon service or its renewal.
NotificationCenter.default.addObserver(self, selector: #selector(self.aiBeaconManagerRegisterServiceSucceeded(_:)), name: NSNotification.Name.AIBeaconManagerRegisterServiceSucceeded, object: nil)
// AIBeacon サービスへの登録／更新成功通知を設定する。
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(aiBeaconManagerRegisterServiceSucceeded:) name:AIBeaconManagerRegisterServiceSucceededNotification object:nil];
// Confitures the notification of success of the registration to the AIBeacon service or its renewal.
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(aiBeaconManagerRegisterServiceSucceeded:) name:AIBeaconManagerRegisterServiceSucceededNotification object:nil];

Class
AIContactInfo

AIBeacon の接触情報。

Contact information of AIBeacon.

Instance PropertyInstance Property
enteredTimeenteredTime

AIBeacon 領域に入った時間。 (UNIX タイム)

Time of entered the AIBeacon's region. (UNIX time)

Declaration

open var enteredTime: Double { get }
@property (readonly, assign, nonatomic) double enteredTime;

Availability

SDK 1.5.0+

Instance PropertyInstance Property
exitedTimeexitedTime

AIBeacon 領域から出た時間。 (UNIX タイム)

Time of exited the AIBeacon's region. (UNIX time)

Declaration

open var exitedTime: Double { get }
@property (readonly, assign, nonatomic) double exitedTime;

Availability

SDK 1.5.0+

Instance PropertyInstance Property
lastProximitylastProximity

直前の AIBeacon との近接度。

Last proximity to AIBeacon.

Declaration

open var lastProximity: CLProximity { get }
@property (readonly, assign, nonatomic) CLProximity lastProximity;

Availability

SDK 1.4.0+

Instance PropertyInstance Property
proximityproximity

AIBeacon との近接度。

Proximity to AIBeacon.

Declaration

open var proximity: CLProximity { get }
@property (readonly, assign, nonatomic) CLProximity proximity;

Availability

SDK 1.4.0+

Instance PropertyInstance Property
rssirssi

AIBeacon からの受信信号強度。

Received signal strength from AIBeacon.

Declaration

open var rssi: Int { get }
@property (readonly, assign, nonatomic) NSInteger rssi;

Availability

SDK 1.4.0+

Instance PropertyInstance Property
stayedTimestayedTime

AIBeacon 領域に滞在した時間。 (秒)

Stayed time in AIBeacon's region. (sec)

Declaration

open var stayedTime: Double { get }
@property (readonly, assign, nonatomic) double stayedTime;

Availability

SDK 1.4.0+

Instance PropertyInstance Property
unitIdunitId

AIBeacon のユニット ID。

Unit ID of AIBeacon.

Declaration

open var unitId: String { get }
@property (readonly, strong, nonatomic, nonnull) NSString * unitId;

Availability

SDK 1.4.0+

EnumerationEnumeration
AIBeaconRequestLocationServiceAuthorizationType

位置情報サービスへのアクセス要求の承認タイプを指定します。

Specifies the authorization type of the access request to the location information service.

Declaration

enum AIBeaconRequestLocationServiceAuthorizationType: Int
typedef NS_ENUM(NSInteger, AIBeaconRequestLocationServiceAuthorizationType) { ... };

Enumeration CaseEnumeration Case
AIBeaconRequestLocationServiceAuthorizationType.alwaysAIBeaconRequestLocationServiceAuthorizationTypeAlways

常に許可することを要求します。

Requests the your app to access the user's location information at all times.

Declaration

case always = 0
AIBeaconRequestLocationServiceAuthorizationTypeAlways = 0

Availability

SDK 1.4.0+

Enumeration CaseEnumeration Case
AIBeaconRequestLocationServiceAuthorizationType.whenInUseAIBeaconRequestLocationServiceAuthorizationTypeWhenInUse

アプリ使用中のみ許可することを要求します。

Requests the your app to access the user's location information while your app is in use.

Declaration

case whenInUse = 1
AIBeaconRequestLocationServiceAuthorizationTypeWhenInUse = 1

Availability

SDK 1.4.0+

Class
AINotificationData

AIBeacon のプッシュ通知データ。

Push notification data from AIBeacon.

Instance PropertyInstance Property
messagemessage

AIBeacon プッシュ通知のメッセージ。

Message of the push notification of AIBeacon.

Declaration

var message: String? { get }
@property (readonly, strong, nonatomic, nullable) NSString * message;

Availability

SDK 1.2.0+

Instance PropertyInstance Property
titletitle

AIBeacon プッシュ通知のタイトル。

Title of the push notification of AIBeacon.

Declaration

var title: String? { get }
@property (readonly, strong, nonatomic, nullable) NSString * title;

Availability

SDK 1.2.0+

Instance PropertyInstance Property
urlurl

AIBeacon プッシュ通知の URL。

URL of the push notification of AIBeacon.

Declaration

var url: URL? { get }
@property (readonly, strong, nonatomic, nullable) NSURL * url;

Availability

SDK 1.2.0+

Information Property List Key

Availability

SDK 1.11.5+

API Reference | AIBeaconSDK for iOS

Language

ClassAIBeaconManager

InitializerInstance Methodinit(appId:apiKey:)initWithAppId:apiKey:

Declaration

Parameters

Return Value

Import Statement

Availability

Example

InitializerInstance Methodinit(appId:apiKey:options:)initWithAppId:apiKey:options:

Declaration

Parameters

Return Value

Import Statement

Availability

Example

Instance PropertyInstance PropertyaiBeaconsaiBeacons

Declaration

Discussion

Availability

Example

Instance PropertyInstance PropertyisDebugEnabledisDebugEnabled

Declaration

Discussion

Availability

Example

Instance PropertyInstance PropertynumberOfAIBeaconsnumberOfAIBeacons

Declaration

Discussion

Availability

Example

Instance MethodInstance MethodreceiveNotification(_:)receiveNotificationWithUserInfo:

Declaration

Parameters

Import Statement

Availability

Example

Instance MethodInstance MethodregisterService()registerService

Declaration

Import Statement

Availability

Example

Instance MethodInstance MethodrequestTracking()requestTracking

Declaration

Import Statement

Availability

Example

Instance MethodInstance MethodsetApnsDeviceToken(_:)setApnsDeviceToken:

Declaration

Parameters

Import Statement

Availability

Example

Instance MethodInstance MethodsetCustomParameter(_:value:)setCustomParameterWithKey:value:

Declaration

Parameters

Import Statement

Availability

Example

Instance MethodInstance MethodsetCustomParameters(_:)setCustomParameters:

Declaration

Parameters

Import Statement

Availability

Example

Instance MethodInstance MethodsetDebugEnabled(_:)setDebugEnabled:

Declaration

Parameters

Import Statement

Availability

Example

Instance MethodInstance MethodsetNotificationCloseButtonTitle(_:)setNotificationCloseButtonTitle:

Declaration

Parameters

Import Statement

Availability

Example

Instance MethodInstance MethodsetNotificationDetailButtonTitle(_:)setNotificationDetailButtonTitle:

Declaration

Class
AIBeaconManager

InitializerInstance Method
init(appId:apiKey:)initWithAppId:apiKey:

InitializerInstance Method
init(appId:apiKey:options:)initWithAppId:apiKey:options:

Instance PropertyInstance Property
aiBeaconsaiBeacons

Instance PropertyInstance Property
isDebugEnabledisDebugEnabled

Instance PropertyInstance Property
numberOfAIBeaconsnumberOfAIBeacons

Instance MethodInstance Method
receiveNotification(_:)receiveNotificationWithUserInfo:

Instance MethodInstance Method
registerService()registerService

Instance MethodInstance Method
requestTracking()requestTracking

Instance MethodInstance Method
setApnsDeviceToken(_:)setApnsDeviceToken:

Instance MethodInstance Method
setCustomParameter(_:value:)setCustomParameterWithKey:value:

Instance MethodInstance Method
setCustomParameters(_:)setCustomParameters:

Instance MethodInstance Method
setDebugEnabled(_:)setDebugEnabled:

Instance MethodInstance Method
setNotificationCloseButtonTitle(_:)setNotificationCloseButtonTitle:

Instance MethodInstance Method
setNotificationDetailButtonTitle(_:)setNotificationDetailButtonTitle:

Instance MethodInstance Method
setPushNotificationEnabled(_:)setPushNotificationEnabled:

Instance MethodInstance Method
setServerTransmissionCycleForContactInfoWithSeconds(_:)setServerTransmissionCycleForContactInfoWithSeconds:

Instance MethodInstance Method
setTrackingDescriptionImage(_:)setTrackingDescriptionImage:

Instance MethodInstance Method
setUseIdfaEnabled(_:)setUseIdfaEnabled:

Type MethodType Method
sharedInstance()sharedInstance

Instance MethodInstance Method
startAiBeaconMonitoring()startAiBeaconMonitoring

Instance MethodInstance Method
stopAiBeaconMonitoring()stopAiBeaconMonitoring

Protocol
AIBeaconManagerDelegate

Instance MethodInstance Method
aiBeaconManagerRegisterServiceSucceeded(_:)aiBeaconManagerRegisterServiceSucceeded:

Instance MethodInstance Method
aiBeaconManager(_:didEnterRegionOfAiBeacon:)aiBeaconManager:didEnterRegionOfAiBeacon:

Instance MethodInstance Method
aiBeaconManager(_:didExitRegionOfAiBeacon:)aiBeaconManager:didExitRegionOfAiBeacon:

Instance MethodInstance Method
aiBeaconManager(_:didRangeAiBeacons:)aiBeaconManager:didRangeAiBeacons: