NowData フレームワーク:iOS

NowData フレームワークには、NowGraphQLService、NowTableService、NowAPIService (カスタム API の場合)、NowAttachmentService などの NowData サービスのインスタンス化を可能にするメソッドが含まれています。

NowData - makeApiService(instanceUrl: URL, path: String, completion: @escaping ((Result<NowApiService, NowServiceError>) -> Void))

NowApiService のインスタンスを作成し、完了すると、指定された完了ハンドラーを呼び出します。

表 : 1. パラメーター

名前	タイプ	説明
instanceUrl	URL	サービスが REST API にアクセスする ServiceNow インスタンスの URL。
パス	文字列	API パス。 たとえば、API 呼び出しが https://xxx.service-now.com/api/now/sg/incident の場合、パスは /api/now/sg/incident になります。
完了	@escaping ((Result<NowApiService, NowServiceError>) -> void)	初期化された NowApiService インスタンスまたは 初期化が失敗した理由を示す NowServiceError のいずれかを含む Result<NowApiService, NowServiceError> で呼び出される完了ハンドラー。

表 : 2. 戻り値

タイプ	説明
なし

次のコード例は、この関数を呼び出す方法を示しています。

let path = "api/now/sg"
let apiPublisher = apiService(for: path)

func apiService(for path: String) -> AnyPublisher<NowAPIService, ConfigurationError> {
  guard let instanceURL else {
    return Fail(error: ConfigurationError.invalidInstanceURL)
    .eraseToAnyPublisher()
  }
  return Future { promise in
    NowData.makeApiService(instanceUrl: instanceURL, path: path) { (result) in
      promise(result.mapError { .sdkError($0) })
    }
  }
  .eraseToAnyPublisher()
}

NowData - makeAttachmentService(instanceUrl: URL, completion: @escaping ((Result<NowAttachmentService, NowServiceError>) -> Void))

NowAttachmentService のインスタンスを作成し、完了後に、指定された完了ハンドラーを呼び出します。

表 : 3. パラメーター

名前	タイプ	説明
instanceUrl	URL	サービスが添付ファイルにアクセスする ServiceNow インスタンスの URL。
完了	@escaping ((Result<NowAttachmentService, NowServiceError>) -> void)	初期化された NowAttachmentService インスタンスまたは 初期化が失敗した理由を示す NowServiceError のいずれかを含む Result<NowAttachmentService, NowServiceError> で呼び出される完了ハンドラー。

表 : 4. 戻り値

タイプ	説明
なし

次のコード例は、この関数を呼び出す方法を示しています。

….
guard 
  let jwtUrl = URL(string: "http://13.57.38.237:8080"),
  let instanceUrl = URL(string: "https://mobilecoresdk.service-now.com") else {
    return
  }

// AuthorizationProvider – struct conforming to NowSDKAuthorizationProviding protocol
let authorizationProvider = AuthorizationProvider(userEmail: "[e-mail]", jwtProviderUrl: jwtUrl, clientId: "deb8756b452d201039231ca568f26511")
        
// PermissionProvider – class conforming to DevicePermissionDelegate protocol
let permissionProvider = PermissionProvider()
let config = NowSDKConfiguration(authorizationProvider: authorizationProvider, permissionDelegate: permissionProvider, logLevel: .debug)
	
do {
  try NowSDK.configure(with: config)
  initializeAttachmentService (with: instanceURL)
} catch {
  // Return ConfigurationError.sdkError(error)
}
…..

func initializeAttachmentService(instanceUrl: instanceURL) { result in
  switch result {
    case .success(let service)
      self?.attachmentService = service
    case .failure(let error)
      debug.print(“Creating Attachment service failed with error: \(error.localizedDescription)”)
      self?.attachmentService = nil
  }
}

NowData - makeGraphQLService(instanceUrl: URL, completion: @escaping ((Result<NowGraphQLService, NowServiceError>) -> Void))

NowGraphQLService のインスタンスを作成し、完了すると、指定された完了ハンドラーを呼び出します。

表 : 5. パラメーター

名前	タイプ	説明
instanceUrl	URL	GraphQL サービスを提供する ServiceNow インスタンスの URL。
完了	@escaping ((Result<NowGraphQLService, NowServiceError>) -> void)	初期化された NowGraphQLService インスタンスまたは 初期化が失敗した理由を示す NowServiceError のいずれかを含む Result<NowGraphQLService、NowServiceError> で呼び出される完了ハンドラー。

表 : 6. 戻り値

タイプ	説明
なし

func initializeGraphQLService(instanceUrl: URL) {
  makeGraphQLService(instanceUrl: instanceUrl) { [weak self] result in
    switch result {
    case .success(let service):
      self?.graphQLService = service
    case .failure(let error):
      debugPrint("Creating GraphQL service failed with error: \(error.localizedDescription)")
      self?.graphQLService = nil
    }
  }
}

NowData - makeTableService(instanceUrl: URL, completion: @escaping ((Result<NowTableService, NowServiceError>) -> Void))

NowTableService のインスタンスを作成し、完了後に、指定された完了ハンドラーを呼び出します。

表 : 7. パラメーター

名前	タイプ	説明
instanceUrl	URL	サービスがテーブルにアクセスする ServiceNow インスタンスの URL。
完了	@escaping ((result<NowTableService, NowServiceError>) -> void)	初期化された NowTableService インスタンスまたは 初期化が失敗した理由を示す NowServiceError のいずれかを含む Result<NowTableService, NowServiceError> で呼び出される完了ハンドラー。

表 : 8. 戻り値

タイプ	説明
なし

次のコード例は、この関数を呼び出す方法を示しています。

func initializeTableService(for instanceUrl: URL) {
  makeTableService(instanceUrl: instanceUrl) { [weak self] result in
    guard let self = self else { return }
            
    switch result {
      case .success(let tableService):
        self.tableService = tableService
        // Create a Paginator that will iterate over pages of customer support cases. The Paginator's response type will be
        // inferred from the Paginator's type definition (e.g. `Paginator<[CustomerServiceCase]>`).
        self.paginator = tableService.paginator(from: Self.tableName, configuration: self.fetchConfiguration)
        // Subscribe to the Paginator's publisher so we will be able to receive paged results.
        self.subscribeToPaginatorPublisher()
        // As we are now ready to start fetching data, inform the view controller.
        self.onReady(self)
      case .failure(let error):
        debugPrint("Creating table service failed with error: \(error.localizedDescription)")
        self.tableService = nil
        self.paginator = nil
    }
  }
}