API Reference - Theymes

All SDK methods are static and are called on the Theymes class.

ImportantBefore you can use any other functions of the SDK, you must initialize it. See Installing the SDK for more information.

Initialization

initialize

Initializes the SDK with the given token and domain. You can optionally pass an options dictionary to override the SDK API domain.

Swift
Objective-C

Theymes.initialize(token: String, domain: String)
Theymes.initialize(token: String, domain: String, options: NSDictionary?)

+ (void)initializeWithToken:(NSString *)token domain:(NSString *)domain;
+ (void)initializeWithToken:(NSString *)token domain:(NSString *)domain options:(NSDictionary *)options;

Options (optional) — when passing the third parameter:

Key	Type	Description
`apiDomain`	`string`	Override the default API domain used by the SDK.

Opening and closing

openSupport

Opens the help center. Optionally pass a config dictionary to customize it. See Configuring the SDK for more information.

Swift
Objective-C

Theymes.openSupport()
Theymes.openSupport(config: [String: Any]?)

+ (void)openSupport;
+ (void)openSupportWithConfig:(NSDictionary *_Nullable)config;

openResource

Opens a specific resource from Theymes (e.g. an article or collector). You can get the resource identifier from the Theymes application.

Swift
Objective-C

Theymes.openResource(_ resource: String)
Theymes.openResource(_ resource: String, config: [String: Any]?)

+ (void)openResource:(NSString *)resource;
+ (void)openResource:(NSString *)resource config:(NSDictionary *_Nullable)config;

close

Closes the help center or resource that was opened with openSupport or openResource. Normally the user sees a close button; use this to close programmatically.

Swift
Objective-C

Theymes.close()

+ (void)close;

Notifications

Notifications can be shown when there’s a new message in the user’s open tickets. Typically you would call enableNotifications() when transitioning to menus or other screens, and disableNotifications() when transitioning to gameplay. Notifications are disabled by default.

requestNotificationPermission

Requests permission to show notifications. Call as part of your app initialization flow.

Swift
Objective-C

Theymes.requestNotificationPermission()

+ (void)requestNotificationPermission;

enableNotifications

Enables in-game notifications to be shown to the player.

Swift
Objective-C

Theymes.enableNotifications()

+ (void)enableNotifications;

disableNotifications

Disables in-game notifications.

Swift
Objective-C

Theymes.disableNotifications()

+ (void)disableNotifications;

getUnreadMessageCount

Returns the number of unread messages. You can use this to show a badge or indicator in your UI.

Swift
Objective-C

Theymes.getUnreadMessageCount() -> Int

+ (NSInteger)getUnreadMessageCount;

getUnansweredMessageCount

Returns the number of unanswered messages. You can use this to show a badge or indicator in your UI.

Swift
Objective-C

Theymes.getUnansweredMessageCount() -> Int

+ (NSInteger)getUnansweredMessageCount;

registerPushToken

Registers a device push token with Theymes. Use PushTokenType.apns for Apple Push Notification service or PushTokenType.fcm for Firebase Cloud Messaging. See Push notifications for more information. You can pass either a string (e.g. FCM token) or the raw device token data from didRegisterForRemoteNotificationsWithDeviceToken (APNs); the SDK converts the latter to the expected string format internally.

Swift
Objective-C

// String (e.g. FCM token or pre-converted APNs token)
Theymes.registerPushToken(_ pushToken: String, type: PushTokenType)

// Raw device token (e.g. from didRegisterForRemoteNotificationsWithDeviceToken)
Theymes.registerPushToken(_ deviceToken: Data, type: PushTokenType)
// PushTokenType: .apns, .fcm

// String (e.g. FCM token or pre-converted APNs token)
+ (void)registerPushToken:(NSString *)pushToken type:(PushTokenType)type;

// Raw device token (e.g. from didRegisterForRemoteNotificationsWithDeviceToken:)
+ (void)registerPushTokenWithDeviceToken:(NSData *)deviceToken type:(PushTokenType)type;
// PushTokenTypeApns, PushTokenTypeFcm

handlePendingNotificationAction

Handles a pending notification action when the user tapped a push notification while the app was in the background. Call this when your app becomes active (e.g. in applicationDidBecomeActive). See Push notifications for more information.

Swift
Objective-C

Theymes.handlePendingNotificationAction() -> Bool
Theymes.handlePendingNotificationAction(_ config: [AnyHashable: Any]?) -> Bool

+ (BOOL)handlePendingNotificationAction;
+ (BOOL)handlePendingNotificationAction:(NSDictionary *_Nullable)config;

hasPendingNotificationAction

Returns whether there is a pending notification action to handle.

Swift
Objective-C

Theymes.hasPendingNotificationAction() -> Bool

+ (BOOL)hasPendingNotificationAction;

Config

getLanguage / setLanguage

Get or set the language in which the help center will be displayed.

Swift
Objective-C

Theymes.getLanguage() -> String?
Theymes.setLanguage(_ language: String?)

+ (NSString *_Nullable)getLanguage;
+ (void)setLanguage:(NSString *_Nullable)language;

getPlayer / setPlayer

Get or set the player information. See Configuring the SDK for more information.

Swift
Objective-C

Theymes.getPlayer() -> NSDictionary?
Theymes.setPlayer(_ player: NSDictionary?)

+ (NSDictionary *_Nullable)getPlayer;
+ (void)setPlayer:(NSDictionary *_Nullable)player;

getSignedMetadataToken / setSignedMetadataToken

Get or set the signed metadata token for Player Verification.

Swift
Objective-C

Theymes.getSignedMetadataToken() -> String?
Theymes.setSignedMetadataToken(_ token: String?)

+ (NSString *_Nullable)getSignedMetadataToken;
+ (void)setSignedMetadataToken:(NSString *_Nullable)token;

Breadcrumbs

Breadcrumbs are short diagnostic messages that are timestamped automatically and sent when opening support or a resource. They are kept in memory only and are cleared by clearBreadcrumbs() and reset().

addBreadcrumb / addBreadcrumbs

Swift
Objective-C

Theymes.addBreadcrumb(_ breadcrumb: String)
Theymes.addBreadcrumbs(_ breadcrumbs: [String])

+ (void)addBreadcrumb:(NSString *)breadcrumb;
+ (void)addBreadcrumbs:(NSArray<NSString *> *)breadcrumbs;

clearBreadcrumbs

Swift
Objective-C

Theymes.clearBreadcrumbs()

+ (void)clearBreadcrumbs;

Fields

Fields are key-value pairs that can be used to send additional information to Theymes. Values can be booleans, strings, numbers, or arrays of strings. The field must be configured in the Theymes application first or it will be ignored.

getFields / setFields

Swift
Objective-C

Theymes.getFields() -> [String: Any]
Theymes.setFields(_ fields: [String: Any])

+ (NSDictionary *)getFields;
+ (void)setFields:(NSDictionary *)fields;

addField / addFields

Swift
Objective-C

Theymes.addField(_ key: String, value: Any)
Theymes.addFields(_ fields: [String: Any])

+ (void)addField:(NSString *)key value:(id)value;
+ (void)addFields:(NSDictionary *)fields;

removeField / removeFields / removeAllFields

Swift
Objective-C

Theymes.removeField(_ field: String)
Theymes.removeFields(_ fields: [String])
Theymes.removeAllFields()

+ (void)removeField:(NSString *)field;
+ (void)removeFields:(NSArray<NSString *> *)fields;
+ (void)removeAllFields;

Privacy

isYoungPlayer / setYoungPlayer

Setting the player as a young player also enables privacy mode and lets support agents know they are talking to a young player.

Swift
Objective-C

Theymes.isYoungPlayer() -> Bool
Theymes.setYoungPlayer(_ youngPlayer: Bool)

+ (BOOL)isYoungPlayer;
+ (void)setYoungPlayer:(BOOL)youngPlayer;

isPrivacyMode / setPrivacyMode

Swift
Objective-C

Theymes.isPrivacyMode() -> Bool
Theymes.setPrivacyMode(_ privacyMode: Bool)

+ (BOOL)isPrivacyMode;
+ (void)setPrivacyMode:(BOOL)privacyMode;

Other

isSupported

Returns whether the help center is supported on the current device (iOS 14+).

Swift
Objective-C

Theymes.isSupported() -> Bool

+ (BOOL)isSupported;

getSdkVersion

Returns the version of the SDK.

Swift
Objective-C

Theymes.getSdkVersion() -> String

+ (NSString *)getSdkVersion;

reset

Resets the SDK to its initial state (clears player, fields, tags and breadcrumbs). Useful for logout flows.

Swift
Objective-C

Theymes.reset()

+ (void)reset;

enableLogging / disableLogging

Swift
Objective-C

Theymes.enableLogging()
Theymes.disableLogging()

+ (void)enableLogging;
+ (void)disableLogging;

Events (Delegate)

iOS uses a delegate instead of events. Set Theymes.delegate to an object that conforms to TheymesDelegate. All delegate methods are optional. Callbacks are invoked on the main thread.

Delegate method	Description
`didOpen()`	Called when the help center is opened.
`didClose()`	Called when the help center is closed.
`didUpdateUnreadMessageCount(_:)`	Called when the unread message count changes. Use this to update your UI (e.g. badge).
`didUpdateUnansweredMessageCount(_:)`	Called when the unanswered message count changes. Use this to update your UI (e.g. badge).
`didUpdateSignedMetadataTokenExpiration(_:)`	Called once a minute with the signed metadata token expiration time left in seconds while the app is in the foreground.

Swift
Objective-C

class MyTheymesDelegate: TheymesDelegate {
    func didOpen() { /* help center opened */ }
    func didClose() { /* help center closed */ }
    func didUpdateUnreadMessageCount(_ count: Int) { /* update badge */ }
    func didUpdateUnansweredMessageCount(_ count: Int) { /* update badge */ }
    func didUpdateSignedMetadataTokenExpiration(_ expiresInSeconds: Int) { /* refresh token if needed */ }
}

// Set the delegate (e.g. in application didFinishLaunching)
Theymes.delegate = MyTheymesDelegate()

@interface MyTheymesDelegate : NSObject <TheymesDelegate>
@end

@implementation MyTheymesDelegate
- (void)didOpen { /* help center opened */ }
- (void)didClose { /* help center closed */ }
- (void)didUpdateUnreadMessageCount:(NSInteger)count { /* update badge */ }
- (void)didUpdateUnansweredMessageCount:(NSInteger)count { /* update badge */ }
- (void)didUpdateSignedMetadataTokenExpiration:(NSInteger)expiresInSeconds { /* refresh token if needed */ }
@end

// Set the delegate (e.g. in application didFinishLaunching)
Theymes.delegate = [[MyTheymesDelegate alloc] init];

didUpdateSignedMetadataTokenExpiration(_:) is called only when a signed metadata token is set. It is called immediately when the app comes to the foreground and then once a minute while the app stays in the foreground. The delegate method receives the remaining expiration time in seconds. If the token is already expired, the value is 0 or negative. Your game decides when to refresh the token based on this value. The value is calculated from the client’s clock, so if the clock is not in sync, the reported expiration time is skewed too.

​Initialization

​initialize

​Opening and closing

​openSupport

​openResource

​close

​Notifications

​requestNotificationPermission

​enableNotifications

​disableNotifications

​getUnreadMessageCount

​getUnansweredMessageCount

​registerPushToken

​handlePendingNotificationAction

​hasPendingNotificationAction

​Config

​getLanguage / setLanguage

​getPlayer / setPlayer

​getSignedMetadataToken / setSignedMetadataToken

​Tags

​getTags / setTags

​addTag / addTags

​removeTag / removeTags / removeAllTags

​Breadcrumbs

​addBreadcrumb / addBreadcrumbs

​clearBreadcrumbs

​Fields

​getFields / setFields

​addField / addFields

​removeField / removeFields / removeAllFields

​Privacy

​isYoungPlayer / setYoungPlayer

​isPrivacyMode / setPrivacyMode

​Other

​isSupported

​getSdkVersion

​reset

​enableLogging / disableLogging

​Events (Delegate)

Initialization

initialize

Opening and closing

openSupport

openResource

close

Notifications

requestNotificationPermission

enableNotifications

disableNotifications

getUnreadMessageCount

getUnansweredMessageCount

registerPushToken

handlePendingNotificationAction

hasPendingNotificationAction

Config

getLanguage / setLanguage

getPlayer / setPlayer

getSignedMetadataToken / setSignedMetadataToken

Tags

getTags / setTags

addTag / addTags

removeTag / removeTags / removeAllTags

Breadcrumbs

addBreadcrumb / addBreadcrumbs

clearBreadcrumbs

Fields

getFields / setFields

addField / addFields

removeField / removeFields / removeAllFields

Privacy

isYoungPlayer / setYoungPlayer

isPrivacyMode / setPrivacyMode

Other

isSupported

getSdkVersion

reset

enableLogging / disableLogging

Events (Delegate)