NowCoreService-Klasse – iOS

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 6 Minuten Lesedauer

    • Die NowCoreService -Klasse bietet grundlegende Services für die verschiedenen SDK-Funktionsservices. Diese Klasse darf nur von NowSDK instanziiert werden.

    Funktionsservices wie Now Analytics und NowChat können über die Eigenschaft NowSDK.core auf eine gemeinsam genutzte Core-Instanz zugreifen.

    NowCoreService –accessTokenDidFail(für Service: NowService)

    Benachrichtigt den SDK-Core, dass das Zugriffstoken, das zum Autorisieren der API-Anforderungen an die Instanz ServiceNow für den angegebenen Service verwendet wurde, nicht mehr gültig ist.

    Der SDK-Core gibt ein gültiges Zugriffstoken zurück, wenn er eines generieren kann oder einen Fehler zurückgibt.

    Hinweis:
    Diese Methode ist veraltet. Sie sollten stattdessen die Implementierung der Methode „async/wait“ verwenden.
    Tabelle : 1. Parameter
    Name Typ Beschreibung
    für Service NowService Funktionsservice, der das Zugriffstoken anfordert.
    Tabelle : 2. Ergebnisse
    Typ Beschreibung
    Beliebiger Herausgeber<NowSDK.AccessToken, AccessTokenProviderError> Erfolg: Gültiges Zugriffstoken.

    Fehler: AccessTokenProviderError

    Mögliche Werte:
    • userSessionError
    • „accessTokenRetrieval“ fehlgeschlagen
    • hostReturnedNoTokens: Gibt einen Gastanwender an
    		 

    NowSDK.core()?.accessTokenDidFail(for: someService)
  .mapError { YourCustomError.accessTokenFailed($0) }

.flatMap(self.handleFailedAccessToken())
  .eraseToAnyPublisher()

    NowCoreService: asynchrone Ausnahmen für „accessTokenDidFail(for service: NowService)“.

    Benachrichtigt den SDK-Core, dass das Zugriffstoken, das zum Autorisieren der API-Anforderungen an die Instanz ServiceNow für den angegebenen Service verwendet wurde, nicht mehr gültig ist.

    Der SDK-Core gibt ein gültiges Zugriffstoken zurück, wenn er eines generieren kann oder einen Fehler zurückgibt.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    für Service NowService Funktionsservice, der das Zugriffstoken anfordert.
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    NowSDK.Zugriffstoken Wird zurückgegeben, wenn die Methode erfolgreich ist. Gültiges Zugriffs-Token.
    AccessTokenProviderError Wird ausgelöst, wenn die Methode fehlschlägt. Gibt einen Fehler beim Abrufen eines Zugriffstokens an.
    Mögliche Werte:
    • userSessionError
    • „accessTokenRetrieval“ fehlgeschlagen
    • hostReturnedNoTokens: Gibt einen Gastanwender an

    Die folgenden Codebeispiele zeigen, wie diese Methode aufgerufen wird.

    do {
    let accessToken = try await NowSDK.core()?.accessTokenDidFail(for: someService)
} catch {
    self.handleFailedAccessToken(error)
}

    NowCoreService – canRequestPermission(_ Berechtigung: DevicePermission)

    Fragt die Hostanwendung ab, ob der Service die Geräteberechtigung anfordern darf.

    Diese Funktion fordert keine Berechtigung an, sondern nur, ob die Geräteberechtigung abgefragt werden darf. Funktionsservices sollten diese Funktion aufrufen, um zu bestimmen, ob sie eine gewünschte Geräteberechtigung anfordern dürfen.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Berechtigung DevicePermission Gerät, für das die Anforderung gestellt wird.
    Mögliche Werte (Groß-/Kleinschreibung beachten):
    • Kamera
    • location
    • Mikrofon
    • Fotobibliothek
    • speachRecidention
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    Boolean Kennzeichnung, die angibt, ob die Hostanwendung dem SDK erlaubt, die angegebene Geräteberechtigung anzufordern.
    Mögliche Werte:
    • wahr: Geräteberechtigung kann angefordert werden.
    • „falsch“: Die Geräteberechtigung kann nicht angefordert werden.
    		 

    extension AppDelegate: DevicePermissionDelegate {
  func canRequestPermission(_ permission: DevicePermission) -> Bool {
    return true
  }
}

    NowCoreService: isGuestUser(für Service: NowService) asynchron

    Überprüft, ob der aktuelle Anwender ein Gastanwender ist.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    für Service NowService Funktionsservice, für den die Gastbenutzerprüfung durchgeführt werden soll.
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    Boolean Kennzeichnung, die angibt, ob der aktuelle Anwender ein Gastanwender ist.
    Mögliche Werte:
    • „wahr“: Der aktuelle Anwender des angegebenen Service ist ein Gastanwender.
    • „falsch“: Der aktuelle Anwender des angegebenen Service ist kein Gastanwender.

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    let isGuestUser = await NowSDK.core()?.isGuestUser(for: someService)

    NowCoreService – refreshAllSettings()

    Aktualisiert alle SDK-Einstellungen für alle Services, indem sie erneut von den aktiven Servern abgerufen werden.

    Um bei jeder Aktualisierung aktualisierte SDK-Einstellungswerte zu erhalten, abonnieren Sie den Herausgeber, der durch die Funktion NowCoreService - EinstellungenHerausgeber (für Service: NowService) bereitgestellt wird.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 10. Ergebnisse
    Typ Beschreibung
    Keine 

    NowSDK.core()?.refreshAllSettings()

    NowCoreService – refreshSettings(für Service: NowService)

    Aktualisiert die SDK-Einstellungen für den angegebenen Service, indem sie erneut vom Server abgerufen werden.

    Hinweis:
    Diese Methode ist veraltet. Sie sollten stattdessen die Implementierung der Methode „async/wait“ verwenden.
    Tabelle : 11. Parameter
    Name Typ Beschreibung
    für Service NowService Funktionsservice, z. B. NowChat oder NowAnalytics, der die Aktualisierung der Einstellungen anfordert.
    Tabelle : 12. Ergebnisse
    Typ Beschreibung
    Beliebiger Herausgeber<Settings, SettingsError> Erfolg: Wörterbuch der aktualisierten SDK-Einstellungen. Funktionsservices müssen die zurückgegebenen Daten auf die Einstellungen überprüfen, die für ihre spezifischen Funktionen relevant sind.

    Fehler: „SettingsError“: Typ und Beschreibung des aufgetretenen Fehlers.

    Mögliche Werte:
    • fetchError
    • abrufenFehlgeschlagen
    • ungültiges JSON
    • ungültigerAnbieter
    • nichtautorisiert
    • sdkNotLicensed
    • EinstellungNichtGefunden
    • unbekannt
    		 

    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: asynchrone Würfe von refreshSettings(for service: NowService).

    Aktualisiert die SDK-Einstellungen für den angegebenen Service, indem sie erneut vom Server abgerufen werden.

    Tabelle : 13. Parameter
    Name Typ Beschreibung
    für Service NowService Funktionsservice, z. B. NowChat oder NowAnalytics, der die Aktualisierung der Einstellungen anfordert.
    Tabelle : 14. Ergebnisse
    Typ Beschreibung
    Einstellungen Wird zurückgegeben, wenn die Methode erfolgreich ist. Wörterbuch der aktualisierten SDK-Einstellungen. Funktionsservices müssen die zurückgegebenen Daten auf die Einstellungen überprüfen, die für ihre spezifischen Funktionen relevant sind.
    EinstellungenFehler Wird ausgelöst, wenn die Methode fehlschlägt.
    Mögliche Werte:
    • fetchError
    • abrufenFehlgeschlagen
    • ungültiges JSON
    • ungültigerAnbieter
    • nichtautorisiert
    • sdkNotLicensed
    • EinstellungNichtGefunden
    • unbekannt

    Die folgenden Codebeispiele zeigen, wie diese Methode aufgerufen wird.

    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)

    Ruft ein Zugriffstoken für den angegebenen Service ab.

    Hinweis:
    Diese Methode ist veraltet. Sie sollten stattdessen die Implementierung der Methode „async/wait“ verwenden.
    Tabelle : 15. Parameter
    Name Typ Beschreibung
    für Service NowService Funktionsservice, der das Zugriffstoken anfordert.
    Tabelle : 16. Ergebnisse
    Typ Beschreibung
    Beliebiger Herausgeber<NowSDK.AccessToken, AccessTokenProviderError> Erfolg: NowSDK.AccessToken – Zugriffstoken, das zum Autorisieren von API-Anforderungen verwendet wird, die an eine Instanz ServiceNow gestellt werden.

    Fehler: AccessTokenProviderError: Typ und Beschreibung des aufgetretenen Fehlers.

    Mögliche Werte:
    • „accessTokenRetrieval“ fehlgeschlagen
    • hostReturnedNoTokens : Gibt einen Gastanwender an
    • userSessionError
    		 

    NowSDK.core()?.requestAccessToken(for: someService)

    NowCoreService: asynchrone Auslösungen für requestAccessToken(for service: NowService).

    Ruft ein Zugriffstoken für den angegebenen Service ab.

    Tabelle : 17. Parameter
    Name Typ Beschreibung
    für Service NowService Funktionsservice, der das Zugriffstoken anfordert.
    Tabelle : 18. Ergebnisse
    Typ Beschreibung
    NowSDK.Zugriffstoken Wird zurückgegeben, wenn die Methode erfolgreich ist. Zugriffstoken zum Autorisieren von API-Anforderungen an eine ServiceNow -Instanz.
    AccessTokenProviderError Wird ausgelöst, wenn die Methode fehlschlägt. Gibt einen Fehler beim Abrufen eines Zugriffstokens an.
    Mögliche Werte:
    • „accessTokenRetrieval“ fehlgeschlagen
    • hostReturnedNoTokens : Gibt einen Gastanwender an
    • userSessionError

    Die folgenden Codebeispiele zeigen, wie diese Methode aufgerufen wird.

    do {
    let accessToken = try await NowSDK.core()?.requestAccessToken(for: someService)
} catch {
    self.handleFailedAccessToken(error)
}

    NowCoreService - requestNetworkService(für Service: NowService)

    Gibt einen Verweis auf einen gemeinsam genutzten Netzwerkservice zurück, den Sie zum Senden von API-Anforderungen verwenden können.

    Hinweis:
    Dies ist ein gemeinsam genutzter Service. Das Ändern von Einstellungen oder das Beenden der Sitzung kann zu Problemen bei anderen Funktionsservices führen, die diese Sitzung gemeinsam nutzen.
    Tabelle : 19. Parameter
    Name Typ Beschreibung
    für Service NowService Funktionsservice, der den Netzwerkservice anfordert.
    Tabelle : 20. Ergebnisse
    Typ Beschreibung
    NetworkService Gemeinsam genutzter Netzwerkservice, den Sie für API-Aufrufe verwenden können.

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.

    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)

    Gibt die SDK-Einstellungen für den angegebenen Funktionsservice zurück.

    Hinweis:
    Diese Methode ist veraltet. Sie sollten stattdessen die Implementierung der Methode „async/wait“ verwenden.
    Tabelle : 21. Parameter
    Name Typ Beschreibung
    fürService NowService Funktionsservice, der die Einstellungen anfordert.
    Tabelle : 22. Ergebnisse
    Typ Beschreibung
    Beliebiger Herausgeber<Settings, SettingsError> Erfolg: Einstellungen – Array von SDK-Einstellungen für den angegebenen Funktionsservice.

    Fehler: SettingsError: Typ und Beschreibung des zugehörigen Fehlers.

    Mögliche Werte:
    • fetchError
    • abrufenFehlgeschlagen
    • ungültiges JSON
    • ungültigerAnbieter
    • nichtautorisiert
    • sdkNotLicensed
    • EinstellungNichtGefunden
    • unbekannt
    		 

    NowSDK.core()?.requestSettings(for: someService)

    NowCoreService: asynchrone Ausnahmen für requestSettings(for service: NowService).

    Gibt die SDK-Einstellungen für den angegebenen Funktionsservice zurück.

    Tabelle : 23. Parameter
    Name Typ Beschreibung
    für Service NowService Funktionsservice, der die Einstellungen anfordert.
    Tabelle : 24. Ergebnisse
    Typ Beschreibung
    Einstellungen Wird zurückgegeben, wenn die Methode erfolgreich ist. Array von SDK-Einstellungen für den angegebenen Funktionsservice.
    EinstellungenFehler Wird ausgelöst, wenn die Methode fehlschlägt. Typ und Beschreibung des zugeordneten Fehlers.
    Mögliche Werte:
    • fetchError
    • abrufenFehlgeschlagen
    • ungültiges JSON
    • ungültigerAnbieter
    • nichtautorisiert
    • sdkNotLicensed
    • EinstellungNichtGefunden
    • unbekannt

    Die folgenden Codebeispiele zeigen, wie diese Methode aufgerufen wird.

    do {
    let settings = try await NowSDK.core()?.requestSettings(for: someService)
    print("Received settings: \(settings)")
} catch {
    print("Refresh saved with Settings error: \(error)")
}

    NowCoreService - EinstellungenHerausgeber (für Service: NowService)

    Ruft die Einstellungen für den Herausgeber des angegebenen Service ab.

    Tabelle : 25. Parameter
    Name Typ Beschreibung
    für Service NowService-Protokoll – iOS Funktionsservice, der das Herausgeberabonnement anfordert.
    Tabelle : 26. Ergebnisse
    Typ Beschreibung
    Beliebiger Herausgeber<Settings, Never> Erfolg: Einstellungen – Array von SDK-Einstellungen für den angegebenen Funktionsservice.

    Das folgende Codebeispiel zeigt, wie diese Funktion aufgerufen wird.

    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)