Permutive_iOS v1.4.0 Documentation

Class Options 

@objc(PermutiveOptions)
public class Options: NSObject

Option for the Permutive SDK. This is initialised with project specific information, defined on the Permutive dashboard, for the SDK to use. Option holds the API key, organisation ID and workspace ID. If your project supports multiple workspaces the init supplying the API key, organisation ID and workspace ID should be used, otherwise the init to supply API key and organisation ID is sufficient.

Options Options NSObject NSObject Options->NSObject

Conforms To

NSObject

Initializers

init?(api​Key:​organisation​Id:​workspace​Id:​) 

@objc
    public init?(apiKey apiKeyString: String,
                 organisationId organisationIdString: String,
                 workspaceId workspaceIdString: String)

Initialises Options with your Permutive project's API key, organisation id, and workspace id. Use this init when the Permutive project defined on the dashboard for your application is split into multiple workspaces. Provide the corresponding workspace ID for your application.

Parameters

api​Key​String String

The project API key. The API key is provided in your project's Permutive dashboard settings for the iOS platform.
organisation​Id String

The unique identifier for your organisation. The organisation ID is provided in your project's Permutive dashboard settings for the iOS platform.
workspace​Id String

The workspace ID of your organisation's project this application is for.

init?(api​Key:​organisation​Id:​) 

@objc
    public init?(apiKey apiKeyString: String,
                 organisationId organisationIdString: String)

Initialises Options with your Permutive project's API key and organisation id. Use this init when the Permutive project defined on the dashboard for your application does not define multiple workspaces.

Parameters

api​Key​String String

The project API key. The API key is provided in your project's Permutive dashboard settings for the iOS platform.
organisation​Id String

The unique identifier for your organisation. The organisation ID is provided in your project's Permutive dashboard settings for the iOS platform.

Properties

api​Key 

public let apiKey: UUID

Pubic API key UUID for customer project

organisation​Id 

public let organisationId: UUID

Organisation ID UUID of customer project

workspace​Id 

public let workspaceId: UUID

Workspace ID UUID of customer project

log​Modes 

public var logModes: [LogMode] = []

The collection of log modes for logging, if any

debug​Description 

override public var debugDescription: String