GNSSubscriptionParams Class
Stay organized with collections
Save and categorize content based on your preferences.
Optional parameters for a subscription.
See the property declarations below for explanations of each parameter.
Inherits NSObject.
| - (GNSDeviceTypes) deviceTypesToDiscover |
|
readwritenonatomicassign |
The types of devices to discover.
The default is kGNSDeviceUsingNearby.
| - (NSString*) messageNamespace |
|
readwritenonatomicassign |
The message namespace to match.
The empty string is the default namespace, and is private to each app (or apps sharing a Google Developer Console project).
The message type to match. Must not be nil. The empty string is the default type.
The strategy to use for discovering Nearby devices (non-beacons).
The strategy to use for beacon scanning.
| - (GNSOperationStatusHandler) statusHandler |
|
readwritenonatomiccopy |
A handler for subscription status.
It can be used for tracking the status of a newly created subscription.
| - (GNSPermissionRequestHandler) permissionRequestHandler |
|
readwritenonatomiccopy |
A handler for requesting user permission to use Nearby.
This handler overrides the default dialog used by Nearby; if you supply this handler, Nearby will not show its permission dialog.
In your request handler, you should request the user's permission to perform the task that requires the use of Nearby, explaining why it's being used. When the user has given or denied consent, you must call the block that's passed into your request handler. If you pass YES into the block, it means the user has consented to allow Nearby to function. If you pass NO, it means the user has not consented; your publications and subscriptions will not work until consent has been given.
The handler can also be used as a method of "preflighting" for the iOS permission dialogs. You can use it to explain why the user is expected to consent to the iOS permissions before your app can perform its Nearby related functions.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-12 UTC.
[null,null,["Last updated 2025-08-12 UTC."],[[["\u003cp\u003e\u003ccode\u003eGNSSubscriptionParams\u003c/code\u003e provides optional parameters for customizing Nearby Messages subscriptions.\u003c/p\u003e\n"],["\u003cp\u003eParameters include device types, message namespace and type, discovery strategies, and handlers for status and permissions.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003estrategy\u003c/code\u003e property controls discovery of Nearby devices, while \u003ccode\u003ebeaconStrategy\u003c/code\u003e is for beacon scanning.\u003c/p\u003e\n"],["\u003cp\u003eYou can define handlers to monitor subscription status and manage user permission requests for Nearby.\u003c/p\u003e\n"],["\u003cp\u003eDefault values are provided for most parameters, simplifying basic subscription setup.\u003c/p\u003e\n"]]],[],null,["# GNSSubscriptionParams Class\n\n[Properties](#properties) \nGNSSubscriptionParams Class Reference \n\nOverview\n--------\n\nOptional parameters for a subscription.\n\nSee the property declarations below for explanations of each parameter.\n\nInherits NSObject.\n\n|----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|\n| Property Summary ---------------- ||\n| GNSDeviceTypes | [deviceTypesToDiscover](/nearby/messages/ios/reference/interface_g_n_s_subscription_params#aa972c219c7211e4a7c5fa785d0b11274) |\n| | The types of devices to discover. [More...](#aa972c219c7211e4a7c5fa785d0b11274) |\n| ||\n| NSString \\* | [messageNamespace](/nearby/messages/ios/reference/interface_g_n_s_subscription_params#a70e97d712c8bc53a7f9076055a91256a) |\n| | The message namespace to match. [More...](#a70e97d712c8bc53a7f9076055a91256a) |\n| ||\n| NSString \\* | [type](/nearby/messages/ios/reference/interface_g_n_s_subscription_params#a86a3f486660ee32e5824b03fcef62533) |\n| | The message type to match. Must not be nil. The empty string is the default type. [More...](#a86a3f486660ee32e5824b03fcef62533) |\n| ||\n| [GNSStrategy](/nearby/messages/ios/reference/interface_g_n_s_strategy) \\* | [strategy](/nearby/messages/ios/reference/interface_g_n_s_subscription_params#a20f64cb0cfd8890f640536dfb586e814) |\n| | The strategy to use for discovering Nearby devices (non-beacons). [More...](#a20f64cb0cfd8890f640536dfb586e814) |\n| ||\n| [GNSBeaconStrategy](/nearby/messages/ios/reference/interface_g_n_s_beacon_strategy) \\* | [beaconStrategy](/nearby/messages/ios/reference/interface_g_n_s_subscription_params#a2a2c2aecb81fef6ff47fc4204110f6da) |\n| | The strategy to use for beacon scanning. [More...](#a2a2c2aecb81fef6ff47fc4204110f6da) |\n| ||\n| GNSOperationStatusHandler | [statusHandler](/nearby/messages/ios/reference/interface_g_n_s_subscription_params#afb1a6c67329810c58745f2f4625240cc) |\n| | A handler for subscription status. [More...](#afb1a6c67329810c58745f2f4625240cc) |\n| ||\n| GNSPermissionRequestHandler | [permissionRequestHandler](/nearby/messages/ios/reference/interface_g_n_s_subscription_params#ac037a18632caddcdb730bdb2a0f9c1b1) |\n| | A handler for requesting user permission to use Nearby. [More...](#ac037a18632caddcdb730bdb2a0f9c1b1) |\n| ||\n\nProperty Detail\n---------------\n\n|-------------------------------------------------------------------------------------------|--------------------------|\n| |------------------------------------------| | - (GNSDeviceTypes) deviceTypesToDiscover | | readwritenonatomicassign |\n\nThe types of devices to discover.\n\nThe default is `kGNSDeviceUsingNearby`. \n\n|-------------------------------------------------------------------------|--------------------------|\n| |---------------------------------| | - (NSString\\*) messageNamespace | | readwritenonatomicassign |\n\nThe message namespace to match.\n\nThe empty string is the default namespace, and is private to each app (or apps sharing a Google Developer Console project). \n\n|-------------------------------------------------|--------------------------|\n| |---------------------| | - (NSString\\*) type | | readwritenonatomicassign |\n\nThe message type to match. Must not be nil. The empty string is the default type. \n\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|\n| |---------------------------------------------------------------------------------------| | - ([GNSStrategy](/nearby/messages/ios/reference/interface_g_n_s_strategy)\\*) strategy | | readwritenonatomicassign |\n\nThe strategy to use for discovering Nearby devices (non-beacons). \n\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|\n| |----------------------------------------------------------------------------------------------------------| | - ([GNSBeaconStrategy](/nearby/messages/ios/reference/interface_g_n_s_beacon_strategy)\\*) beaconStrategy | | readwritenonatomicassign |\n\nThe strategy to use for beacon scanning. \n\n|-------------------------------------------------------------------------------------------------|------------------------|\n| |---------------------------------------------| | - (GNSOperationStatusHandler) statusHandler | | readwritenonatomiccopy |\n\nA handler for subscription status.\n\nIt can be used for tracking the status of a newly created subscription. \n\n|---------------------------------------------------------------------------------------------------------------------------|------------------------|\n| |----------------------------------------------------------| | - (GNSPermissionRequestHandler) permissionRequestHandler | | readwritenonatomiccopy |\n\nA handler for requesting user permission to use Nearby.\n\nThis handler overrides the default dialog used by Nearby; if you supply this handler, Nearby will not show its permission dialog.\n\nIn your request handler, you should request the user's permission to perform the task that requires the use of Nearby, explaining why it's being used. When the user has given or denied consent, you must call the block that's passed into your request handler. If you pass `YES` into the block, it means the user has consented to allow Nearby to function. If you pass `NO`, it means the user has not consented; your publications and subscriptions will not work until consent has been given.\n\nThe handler can also be used as a method of \"preflighting\" for the iOS permission dialogs. You can use it to explain why the user is expected to consent to the iOS permissions before your app can perform its Nearby related functions."]]
