如果无法找到特定字段，则从Info.plist加载字段可能会抛出以下错误：

连接

一旦创建了一个初始化的Connect类实例，你就能开始应用程序与Civic之间的连接。为了发起一个流程，你可以使用Connect.connect(withType:delegate:)方法

Swift

connect.connect(withType: .basic, delegate: self)

Objective-C

[connect connectWithType:CCScopeRequestTypeBasic delegate:self];

要确定使用哪种类型，你需要知道你需要哪些信息。以下表格显示了这些类型提供的信息

代表者是库通过以下方法通过合作伙伴通讯的方式

与Civic连接后，创建一个ConnectSession来处理合作伙伴应用程序和Civic之间的连接。一旦创建了ConnectSession，你就有了两种处理会话的方式。一种是通过Connect.handle(url:)方法处理用于打开合作伙伴应用程序的URL，另一种是调用Connect.startPollingForUserData()方法。以下将描述这些方法。

处理 URL

处理一个 URL 将允许库确定公民应用程序是否打开了/重定向到合作伙伴应用程序，并开始检索用户数据。为了让此功能正常工作，必须在 Info.plist 中设置一个带有 URL 规约 的 URL 类型。（请参见示例项目了解如何实现）

处理 URL 的一个方便位置是在 AppDelegate 中的 func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey : Any] = [:]) -> Bool 方法如下

Swift

func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey : Any] = [:]) -> Bool {
    return connect.handle(url: url)
}

Objective-C

- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(nullable NSString *)sourceApplication annotation:(id)annotation {
    return [connect handleUrl:url];
}

内部将检查该 URL 是否由公民应用程序启动。您可以通过 Connect.canHandle(url:) 手动检查 URL。如果会话可以处理该 URL，则它会内部调用 Connect.startPollingForUserData()。

开始轮询用户数据

如果您不选择处理 URL 方法，或者您宁愿不使用重定向机制，您可以选择手动开始轮询用户数据。当调用此方法时，它将启动一个定时器，不断检查公民应用程序是否完成了流程。

Swift

connect.startPollingForUserData()

Objective-C

[connect startPollingForUserData];

停止轮询用户数据

在任何时候启动会话时，您可以通过调用Connect.stopPollingForUserData()来使计时器失效。

Swift

connect.stopPollingForUserData()

Objective-C

[connect stopPollingForUserData];

重置

您可以通过调用Connect.reset()函数来重置Connect实例的状态。

Swift

connect.reset()

Objective-C

[connect reset];

连接按钮

如果您想要一个Civic风格的按钮，可以使用ConnectButton类，它只是UIButton的一个子类。为了创建一个，您需要提供一个Connect实例、一个ConnectDelegate，以及可选的ScopeRequestType。

Swift

let connectButton = ConnectButton(<INSERT CONNECT HERE>, 
                                  type: <INSERT SCOPE REQUEST TYPE HERE (DEFAULTS TO .basic)>, 
                                  delegate: <INSERT CONNECT DELEGATE HERE>)

Objective-C

CCConnectButton *connectButton = [[CCConnectButton alloc] initWithConnect:<INSERT CONNECT HERE>
                                                                     type:<INSERT SCOPE REQUEST TYPE HERE>
                                                                 delegate:<INSERT CONNECT DELEGATE HERE>];

创建完毕后，您可以自定义按钮的标题和图片

Swift

connectButton.setConnectTitle(<INSERT TITLE HERE>, image: <INSERT IMAGE HERE>)
connectButton.setConnectTitle(<INSERT TITLE HERE>)

Objective-C

[connectButton setConnectTitle:<INSERT TITLE HERE> image:<INSERT IMAGE HERE>];
[connectButton setConnectTitle:<INSERT TITLE HERE>];

作用域请求类型也可以随时更改

Swift

connectButton.setType(<INSERT SCOPE REQUEST TYPE HERE>)

Objective-C

[connectButton setType:<INSERT SCOPE REQUEST TYPE HERE>];

任何时候轻触ConnectButton按钮，它将开始连接到Civic应用程序，并在按钮上显示加载指示器。一旦会话接收到了错误或成功响应，加载指示器将消失。

错误

下表显示了通过库可能发生的潜在错误

下表显示了通过服务器API可能发生的潜在错误

常见问题解答（FAQ）

我们使用什么作为重定向方案？

您可以使用任何对您的应用有效的唯一方案。

我们如何从UserInfo中获取UIImage？

一些UserInfo对象使用Base64编码存储值，例如，对于documents.genericId.image的UserInfo对象，我们可以使用以下代码片段进行解码，以将其解码为UIImage：

func decodeBase64ToImage(_ userInfo: UserInfo) -> UIImage? {
    guard let data = Data(base64Encoded: userInfo.value, options: .ignoreUnknownCharacters) else {
    return nil
    }

    return UIImage(data: data)
}

当我收到Unauthorized: no platforms found for provided app_id时，意味着什么？

这意味着你提供的应用标识符不正确。请确保你在配置的应用下从集成门户中获得了正确的App ID。

当我收到Unauthorized: mobileId not found in partner platform list时，意味着什么？

这表示你没有提供正确的Bundle ID，或者你没有在集成门户上配置你的移动应用程序。

我该如何仅检索JWT令牌以便在我的端处理用户数据？

为了仅检索JWT令牌，在你的ConnectDelegate实现中，实现func connectShouldFetchUserData(withToken token: String) -> Bool函数并返回false。该函数中提供的token是JWT令牌，可以通过所需的方式进行处理。

作者

请参阅参与此项目的贡献者列表。

贡献

在CONTRIBUTING文件中查找贡献指南。

许可证

Civic App Connect 在MIT许可证下可用。有关更多信息，请参阅LICENSE文件。