NowCoreService class - iOS
The NowCoreService class provides fundamental services to the various SDK feature services. This class should only be instantiated by NowSDK.
Feature services, such as Now Analytics and NowChat, can access a shared core instance through the NowSDK.core property.
NowCoreService - accessTokenDidFail(for service: NowService)
Notifies the SDK core that the access token used to authorize the API requests to the ServiceNow instance for the specified service is no longer valid.
The SDK core returns a valid access token if it is able to generate one or returns an error.
| Name | Type | Description |
|---|---|---|
| for service | NowService | Feature service requesting the access token. |
| Type | Description |
|---|---|
| AnyPublisher<NowSDK.AccessToken, AccessTokenProviderError> | Success: Valid access token. Failure: AccessTokenProviderError Possible values:
|
NowSDK.core()?.accessTokenDidFail(for: someService)
.mapError { YourCustomError.accessTokenFailed($0) }
.flatMap(self.handleFailedAccessToken())
.eraseToAnyPublisher()
NowCoreService - accessTokenDidFail(for service: NowService) async throws
Notifies the SDK core that the access token used to authorize the API requests to the ServiceNow instance for the specified service is no longer valid.
The SDK core returns a valid access token if it is able to generate one or returns an error.
| Name | Type | Description |
|---|---|---|
| for service | NowService | Feature service requesting the access token. |
| Type | Description |
|---|---|
| NowSDK.AccessToken | Returned when the method is successful. Valid access token. |
| AccessTokenProviderError | Thrown when the method fails. Indicates an error retrieving an access token. Possible values:
|
The following code examples shows how to call this method.
do {
let accessToken = try await NowSDK.core()?.accessTokenDidFail(for: someService)
} catch {
self.handleFailedAccessToken(error)
}
NowCoreService - canRequestPermission(_ permission: DevicePermission)
Queries the host application as to whether the service is allowed to request the device permission.
This function does not request the permission, only whether it is allowed to query the device permission. Feature services should call this function to determine if they are allowed to request a desired device permission.
| Name | Type | Description |
|---|---|---|
| permission | DevicePermission | Device for which the request is being made. Possible values (case-sensitive):
|
| Type | Description |
|---|---|
| Boolean | Flag that indicates whether the host application allows the SDK to request the
specified device permission. Possible values:
|
extension AppDelegate: DevicePermissionDelegate {
func canRequestPermission(_ permission: DevicePermission) -> Bool {
return true
}
}
NowCoreService - isGuestUser(for service: NowService) async
Checks whether the current user is a guest user.
| Name | Type | Description |
|---|---|---|
| for service | NowService | Feature service for which to perform the guest user check. |
| Type | Description |
|---|---|
| Boolean | Flag that indicates whether the current user is a guest user. Possible values:
|
The following code example shows how to call this method.
let isGuestUser = await NowSDK.core()?.isGuestUser(for: someService)
NowCoreService - refreshAllSettings()
Refreshes all SDK settings for all services by re-fetching them from the active servers.
To receive updated SDK settings values whenever they're refreshed, subscribe to the publisher provided by the NowCoreService - settingsPublisher(for service: NowService) function.
| Name | Type | Description |
|---|---|---|
| None |
| Type | Description |
|---|---|
| None |
NowSDK.core()?.refreshAllSettings()
NowCoreService - refreshSettings(for service: NowService)
Refreshes the SDK settings for the specified service by re-fetching them from the server.
| Name | Type | Description |
|---|---|---|
| for service | NowService | Feature service, such as NowChat or NowAnalytics, requesting the settings refresh. |
| Type | Description |
|---|---|
| AnyPublisher<Settings, SettingsError> | Success: Dictionary of refreshed SDK settings. Feature services need to examine the returned data for the settings relevant to their specific features. Failure: SettingsError - Type and description of error encountered. Possible values:
|
var subscriptions = Set<AnyCancellable>()
NowSDK.core?.refreshSettings(for: someService)
.sink(receiveCompletion: { completion in
if case .failure(let error) = completion {
print("Refresh failed with error:\ (error)")
}
}, receiveValue: { settings in
print("Received refreshed settings:\ (settings)")
})
.store(in: &subscriptions)
NowCoreService - refreshSettings(for service: NowService) async throws
Refreshes the SDK settings for the specified service by re-fetching them from the server.
| Name | Type | Description |
|---|---|---|
| for service | NowService | Feature service, such as NowChat or NowAnalytics, requesting the settings refresh. |
| Type | Description |
|---|---|
| Settings | Returned when the method is successful. Dictionary of refreshed SDK settings. Feature services need to examine the returned data for the settings relevant to their specific features. |
| SettingsError | Thrown when the method fails. Possible values:
|
The following code examples shows how to call this method.
do {
let settings = try await NowSDK.core()?.refreshSettings(for: someService)
print("Received refreshed settings: \(settings)")
} catch {
print("Refresh failed with Settings error: \(error)")
}
NowCoreService - requestAccessToken(for service: NowService)
Acquires an access token for the specified service.
| Name | Type | Description |
|---|---|---|
| for service | NowService | Feature service requesting the access token. |
| Type | Description |
|---|---|
| AnyPublisher<NowSDK.AccessToken, AccessTokenProviderError> | Success: NowSDK.AccessToken - Access token to use to authorize API requests made to a ServiceNow instance. Failure: AccessTokenProviderError - Type and description of error encountered. Possible values:
|
NowSDK.core()?.requestAccessToken(for: someService)
NowCoreService - requestAccessToken(for service: NowService) async throws
Acquires an access token for the specified service.
| Name | Type | Description |
|---|---|---|
| for service | NowService | Feature service requesting the access token. |
| Type | Description |
|---|---|
| NowSDK.AccessToken | Returned when the method is successful. Access token to use to authorize API requests made to a ServiceNow instance. |
| AccessTokenProviderError | Thrown when the method fails. Indicates an error retrieving an access token. Possible values:
|
The following code examples shows how to call this method.
do {
let accessToken = try await NowSDK.core()?.requestAccessToken(for: someService)
} catch {
self.handleFailedAccessToken(error)
}
NowCoreService - requestNetworkService(for service: NowService)
Returns a reference to a shared network service that you can use to make API requests.
| Name | Type | Description |
|---|---|---|
| for service | NowService | Feature service requesting the network service. |
| Type | Description |
|---|---|
| NetworkService | Shared network service that you can use to make API calls. |
The following code example shows how to call this function.
NowSDK.core()?.settingsPublisher(for: chatService)
.sink(receiveCompletion: { completion in
if case .failure(let error) = completion {
// Setting publisher failed with error
}
}, receiveValue: { updatedSettings in
// Receive array of SDK settings for chatService
})
.store(in: &subscriptions)
NowCoreService - requestSettings(forservice: NowService)
Returns the SDK settings for the specified feature service.
| Name | Type | Description |
|---|---|---|
| forservice | NowService | Feature service requesting the settings. |
| Type | Description |
|---|---|
| AnyPublisher<Settings, SettingsError> | Success: Settings - Array of SDK settings for the specified feature
service. Failure: SettingsError - Type and description of associated error. Possible values:
|
NowSDK.core()?.requestSettings(for: someService)
NowCoreService - requestSettings(for service: NowService) async throws
Returns the SDK settings for the specified feature service.
| Name | Type | Description |
|---|---|---|
| for service | NowService | Feature service requesting the settings. |
| Type | Description |
|---|---|
| Settings | Returned when the method is successful. Array of SDK settings for the specified feature service. |
| SettingsError | Thrown when the method fails. Type and description of associated error. Possible values:
|
The following code examples shows how to call this method.
do {
let settings = try await NowSDK.core()?.requestSettings(for: someService)
print("Received settings: \(settings)")
} catch {
print("Refresh saved with Settings error: \(error)")
}
NowCoreService - settingsPublisher(for service: NowService)
Retrieves the settings for the publisher of the specified service.
| Name | Type | Description |
|---|---|---|
| for service | NowService protocol - iOS | Feature service requesting the publisher subscription. |
| Type | Description |
|---|---|
| AnyPublisher<Settings, Never> | Success: Settings - Array of SDK settings for the specified feature service. |
The following code example shows how to call this function.
NowSDK.core()?.settingsPublisher(for: chatService)
.sink(receiveCompletion: { completion in
if case .failure(let error) = completion {
// Setting publisher failed with error
}
}, receiveValue: { updatedSettings in
// Receive array of SDK settings for chatService
})
.store(in: &subscriptions)