iOS client integration

Optional method: Get the version number

/**
 *  Gets the current SDK version number.
 *  @return A string that indicates the SDK version number.
 */
- (NSString *_Nonnull)getVersion;

Example

NSString *version = [[TXCommonHandler sharedInstance] getVersion];

Optional method: Check the environment

/**
 *  Checks whether the current environment supports one-click logon or phone number verification. If PNSCodeSuccess is returned in resultDic, the environment is supported.
 *  @param  authType The service type. PNSAuthTypeVerifyToken specifies the phone number verification flow. PNSAuthTypeLoginToken specifies the one-click logon flow.
 *  @param  complete The result is returned asynchronously to the main thread. On success, resultDic=@{resultCode:600000, msg:...}. For other cases, see PNSReturnCode for the "resultCode" value. Subsequent API calls are guaranteed only after a success callback.
 */
- (void)checkEnvAvailableWithAuthType:(PNSAuthType)authType complete:(void (^_Nullable)(NSDictionary * _Nullable resultDic))complete;

Example

[[TXCommonHandler sharedInstance] checkEnvAvailableWithAuthType:PNSAuthTypeVerifyToken complete:^(NSDictionary * _Nullable resultDic) {
        NSLog(@"Environment check result: %@",resultDic);
}];

Optional method: Set the checkbox selection state

/**
 *  After the authorization page is displayed, modifies the selection state of the checkbox. This setting does not take effect if the checkbox is hidden.
 */
- (void)setCheckboxIsChecked:(BOOL)isChecked;

Examples

[[TXCommonHandler sharedInstance] setCheckboxIsChecked:YES];

Optional method: Hide the loading animation after getting the logon token

/**
 *  Manually hides the loading animation that appears after getting the logon token. By default, the animation is hidden automatically. If you set the autoHideLoginLoading property of the TXCustomModel instance to NO, you can call this method to hide the animation manually.
 */
- (void)hideLoginLoading;

Examples

[[TXCommonHandler sharedInstance] hideLoginLoading];

Optional method: Close the secondary authorization pop-up page

/**
 * Closes the secondary authorization pop-up page.
 */
- (void)closePrivactAlertView;

Example

[[TXCommonHandler sharedInstance] closePrivactAlertView];

Follow the system's dark mode on the authorization page

The one-click logon SDK for iOS does not provide built-in UI support that automatically follows the system's dark mode. You can use the UITraitCollection.userInterfaceStyle method from the official Apple developer documentation to determine the user's current appearance mode. Based on the appearance mode, you can manually update UI elements to ensure that the visual experience of the app is consistent with the system settings.

The following code example shows how to make the button text color automatically adjust to the system's appearance mode. You can use this example to adapt the authorization page for dark mode.

// Step 1: Use the initWithDynamicProvider: method of UIColor to create a color that automatically adjusts based on the system's user interface style.
UIColor *buttonColor = [[UIColor alloc] initWithDynamicProvider:^UIColor * _Nonnull(UITraitCollection * 
    _Nonnull traitCollection) {
 
    if (traitCollection.userInterfaceStyle == UIUserInterfaceStyleDark) {
        return [UIColor redColor]; // Color for dark mode
    } else {
        return [UIColor blueColor]; // Color for light mode
    }
}];
// Step 2: Create a dictionary to define the button text attributes, including color and font size. Then, use these attributes to create an attributed string.
NSDictionary *buttonAttributes = @{
    NSForegroundColorAttributeName : buttonColor, // Use the dynamic color
    NSFontAttributeName : [UIFont systemFontOfSize:20.0] // Set the font size
};
model.loginBtnText = [[NSAttributedString alloc] initWithString:@"One-click Logon Button Test"
                                                     attributes:buttonAttributes];

Switch for console log output

/**
 *  The switch for console log output. If enabled, logs are output with the PNS_LOGGER prefix. Remember to disable this in Release mode.
 *  @param enable The switch parameter. Default value: NO.
 */
- (void)setConsolePrintLoggerEnable:(BOOL)enable;

Example

PNSReporter *reporter = [[TXCommonHandler sharedInstance] getReporter];
[reporter setConsolePrintLoggerEnable:YES];

Switch for log and instrumentation data upload

/**
 *  Sets the switch for uploading logs and instrumentation data. This does not affect custom upload methods implemented through the setupUploader: API.
 *  @param  enable A BOOL value for the switch. Default value: YES.
 */
- (void)setUploadEnable:(BOOL)enable;

Example

PNSReporter *reporter = [[TXCommonHandler sharedInstance] getReporter];
[reporter setUploadEnable:YES];

Check if the device's cellular network is enabled (checkDeviceCellularDataEnable)

/**
 Checks if the device's cellular data network (3G or 4G) is enabled.
 @return The result.
 */
+ (BOOL)checkDeviceCellularDataEnable;

Check if the current internet SIM card is from China Unicom (isChinaUnicom)

/**
Checks if the carrier of the current internet SIM card is China Unicom.
@return The result.
*/
+ (BOOL)isChinaUnicom;

Check if the current internet SIM card is from China Mobile (isChinaMobile)

/**
Checks if the carrier of the current internet SIM card is China Mobile.
@return The result.
*/
+ (BOOL)isChinaMobile;

Check if the current internet SIM card is from China Telecom (isChinaTelecom)

/**
Checks if the carrier of the current internet SIM card is China Telecom.
@return The result.
*/
+ (BOOL)isChinaTelecom;

Get the name of the current internet carrier (getCurrentCarrierName)

/**
Gets the name of the current internet carrier, such as China Mobile, China Telecom, or China Unicom.
@return The result.
*/
+ (NSString *)getCurrentCarrierName;

Get the current internet network type (getNetworktype)

/**
Gets the current internet network type, such as Wi-Fi or 4G.
@return The result.
*/
+ (NSString *)getNetworktype;

Check if the device has a SIM card (simSupportedIsOK)

/**
Checks if the current device has a SIM card.
@return The result.
*/
+ (BOOL)simSupportedIsOK;

Check if the wireless network is enabled (isWWANOpen)

/**
 Checks if the wireless network is enabled (detected via the p0 NIC, with or without Wi-Fi).
 @return The result.
 */
+ (BOOL)isWWANOpen;

Check if the wireless network is enabled when not connected to Wi-Fi (reachableViaWWAN)

/**
 Checks if the wireless network is enabled (only when not connected to Wi-Fi).
 @return The result.
 */
+ (BOOL)reachableViaWWAN;

Get the device's current private IP address (getMobilePrivateIPAddress)

/**
 Gets the private IP address of the device's current network.
  @return The result.
 */
+ (NSString *)getMobilePrivateIPAddress:(BOOL)preferIPv4;

Get the unique ID of the current device (getUniqueID)

/**
 Gets the unique ID of the current device, used for precise instrumentation lookups.
 */
+ (NSString *)getUniqueID;

Generate an image from a color setting (imageWithColor)

/**
Generates an image from a color setting. Supports border radius settings, such as for the background image of a one-click logon button.
*/
+ (UIImage *)imageWithColor:(UIColor *)color size:(CGSize)size isRoundedCorner:(BOOL )isRounded radius:(CGFloat)radius;