SupportSDK Documentation

Classes

Article​UiConfiguration

Data class used to configure Article Screen

Help​Center​UiConfiguration

Data class used to configure Help Center

Request​List​UIConfiguration
Request​Ui

Used to build view controller for ticketing. The returned objects must be presented inside a UINavigationController. The containing navigation controller can be presented any way you see fit.

Request​UiConfiguration

Data class used to configure Ticketing

Support​UI
ZDKConstants
Container​View​Controller
Coordinating​View​Controller
Help​Center​Coordinator
Request​Coordinator
Support​Engine
Request​Attachment

Creates an attachment to be uploaded when a request is created

Theme

Used to style the SDK.

Dismiss​Util
Block​Middleware

Create a middleware inline with a block.

Block​Reducer

Create a reducer inline with a block

Combined​Reducer

Reducer that represents a combination of two reducers This reducers is not to be implemented by hand. You combine reducer by adding them with the + operator.

Store

Store that contains the application state, the reducer logic, the middleware and the listeners

Suas​Debug​Logger

Used to enable Suas logging. Suas drives most of the Ticketing UI so the Suas logs can be useful for debugging it. Enabling the Suas logger produces a lot of information and will slow down the SDK.

Help​Center​Article​Voting​Handler
Help​Center​Contact​UsRouter

Structures

Subscription

Subscription structure that represents a listener subscription. When adding a listener you get a subscription back. You can use this subscription to remove the listener, notify about the current state or link the listener lifecycle with an object.

Action​Subscription

Subscription structure that represents a listener subscription. When adding a listener you get a subscription back. You can use this subscription to remove the listener, notify about the current state or link the listener lifecycle with an object.

Block​Async​Action

Create an AsyncAction inline by passing a block to the init Check AsyncAction for more info

Async​Middleware

Async Middleware handles actions of type AsyncAction

Logger​Middleware

LoggerMiddleware that logs the action and state when each action is received When an action is dispatched, the LoggerMiddleware will print information related to it in the console.

State

Structure that represents the store state. The store state is kept as a Dictionary with String Keys and Any Values ([String: Any])

Enumerations

File​Type

Enum that represents the file types that zendesk supports

Suas

Protocols

Container​Child​Controller​Delegate
Container​Child
Coordinator
Window
Application​Type
Middleware

Middleware protocol that represents a suas store middleware A middleware helps extending the dispatch logic of Suas.

Async​Action

Async action this type of action is intercepted by AsyncMiddleware and is not dispatched to the reducer.

Reducer

Protocol that represents a reducer

Suas​Dynamic​Equatable

Protocol used by EqualsFilter filter callback to compare two state values. If your state implements the Equatable protocol there is no code required to implement SuasDynamicEquatable

Action

Action to dispatch to the store

Typealiases

Help​Center​Ui
Help​Center​Delegate
Container​Child​Controller
State​Key

Store state is stored as a Dictionary of [StateKey: Any]

Listener​Function

Callback function called when the listener state is changed

Action​Listener​Function

Callback function called when the action listener state is changed

Filter​Function

Filter function that decides if the listener should be notified or not

State​Selector

Function that selects part of the full state

Keyed​State
Reducer​Function
Dispatch​Function
Next​Function
Middleware​Function
Get​State​Function

Variables

always​Filter

Listener filter callback that always returns true. When using this filter callback the Listener will always be notified.

Equals​Filter

Listener filter callback that returns true if the old state and the new state are not equal. You can use this filter function when adding a listener if you want your notification function to be called when the state changes.

default​Logger

Extensions

UIApplication