DSMManager Class Reference

#import <DSMManager.h>

Inheritance diagram for DSMManager:

Class Methods

(NSString *) + name
 name More...
 
(NSString *) + buildVersion
 buildVersion More...
 
(void) + setup
 Sets up managed context. should be called from application:​did​Finish​Launching​With​Options: More...
 
(void) + setLoggingLevel:
 setup logging level. More...
 
(void) + setupWithConfiguration:
 setup with configuration to override the default behaviors. More...
 
(BOOL) + configuredValueForSetupKey:
 query saved configuration value for a given key. If no custom configuration found, it will return the default value for given configuration key. More...
 
(NSDictionary< NSString *, NSString * > *) + defaultConfigurations
 default configurations More...
 
(void) + loginWithUserId:password:integratorKey:host:completionBlock:
 Sets up DocuSign user account for SDK usage. More...
 
(void) + loginWithAccessToken:accountId:userId:userName:email:host:integratorKey:completion:
 Sets up DocuSign user account for SDK usage in OAuth case(this is currently only for Docusign Client App). More...
 
(void) + loginWithApiPassword:accountId:userId:userName:email:host:integratorKey:completion:
 Sets up DocuSign user account for SDK usage in OAuth case(this is currently only for Docusign Client App). More...
 
(BOOL) + clearCredentialsAndCachedTemplates
 clean/clear all local storage and user data - called when user logs out. Note: Invoking this method will also remove any of the offline signed envelopes. More...
 

Detailed Description

It contains helper class methods to setup, login and clear credentials upon logout. setupWithConfiguration provides customization options to adjust global settings for DocuSignSDK.

See also
DSMTemplatesManager.h

Method Documentation

◆ buildVersion()

+ (NSString *) buildVersion

buildVersion

◆ clearCredentialsAndCachedTemplates()

+ (BOOL) clearCredentialsAndCachedTemplates

clean/clear all local storage and user data - called when user logs out. Note: Invoking this method will also remove any of the offline signed envelopes.

See also
DSMEnvelopesManager to manage cached envelopes
DSMTemplatesManager to manage cached templates

◆ configuredValueForSetupKey:()

+ (BOOL) configuredValueForSetupKey: (NSString *)  key

query saved configuration value for a given key. If no custom configuration found, it will return the default value for given configuration key.

See also
+ defaultConfigurations

◆ defaultConfigurations()

+ (NSDictionary<NSString *, NSString *> *) defaultConfigurations

default configurations

◆ loginWithAccessToken:accountId:userId:userName:email:host:integratorKey:completion:()

+ (void) loginWithAccessToken: (NSString *)  accessToken
accountId: (NSString *)  accountId
userId: (NSString *)  userId
userName: (NSString *)  userName
email: (NSString *)  email
host: (NSURL *)  host
integratorKey: (NSString *)  integratorKey
completion: (void(^)(NSError *error))  completionBlock 

Sets up DocuSign user account for SDK usage in OAuth case(this is currently only for Docusign Client App).

Parameters
accessTokenDocuSign oAuthToken.
accountIdDocuSign accountId of the user using SDK for sign and send.
userIdDocuSign userId of the user using SDK for sign and send.
userNameDocuSign username of the user using SDK for sign and send.
emailDocuSign registered emaildId of the user using SDK for sign and send.
hostDocuSign host where user is signed up with DocuSign (e.g. "https://demo.docusign.net/restapi").
integratorKeyDocuSign integratorKey for the client application.
completionBlockto be executed after user account is setup.

◆ loginWithApiPassword:accountId:userId:userName:email:host:integratorKey:completion:()

+ (void) loginWithApiPassword: (NSString *)  apiPassword
accountId: (NSString *)  accountId
userId: (NSString *)  userId
userName: (NSString *)  userName
email: (NSString *)  email
host: (NSURL *)  host
integratorKey: (NSString *)  integratorKey
completion: (void(^)(NSError *error))  completionBlock 

Sets up DocuSign user account for SDK usage in OAuth case(this is currently only for Docusign Client App).

Parameters
apiPasswordDocuSign apiPassword.
accountIdDocuSign accountId of the user using SDK for sign and send.
userIdDocuSign userId of the user using SDK for sign and send.
userNameDocuSign username of the user using SDK for sign and send.
emailDocuSign registered emaildId of the user using SDK for sign and send.
hostDocuSign host where user is signed up with DocuSign (e.g. "https://demo.docusign.net/restapi").
integratorKeyDocuSign integratorKey for the client application.
completionBlockto be executed after user account is setup.

◆ loginWithUserId:password:integratorKey:host:completionBlock:()

+ (void) loginWithUserId: (NSString *)  userName
password: (NSString *)  password
integratorKey: (NSString *)  integratorKey
host: (NSURL *)  url
completionBlock: (void(^)(NSError *))  completionBlock 

Sets up DocuSign user account for SDK usage.

Parameters
userNameDocuSign username of the user using SDK for sign and send.
passwordDocuSign pasword of the user using SDK for sign and send.
integratorKeyDocuSign integratorKey for the client application.
urlDocuSign host where user is signed up with DocuSign (e.g. "https://demo.docusign.net/restapi").
completionBlockto be executed after user account is setup.

◆ name()

+ (NSString *) name

name

◆ setLoggingLevel:()

+ (void) setLoggingLevel: (DSMLoggingLevel)  level

setup logging level.

Parameters
levellevel of Logging required.
See also
DSMLoggingLevel.h

◆ setup()

+ (void) setup

Sets up managed context. should be called from application:​did​Finish​Launching​With​Options:

◆ setupWithConfiguration:()

+ (void) setupWithConfiguration: (NSDictionary< NSString *, NSString * > *)  configuration

setup with configuration to override the default behaviors.

Example: NSMutableDictionary<NSString *, NSString *> *configuration = [[DSMManager defaultConfigurations] mutableCopy]; [configuration setValue:DSM_SETUP_TRUE_VALUE forKey:DSM_SETUP_OFFLINE_SIGNING_HIDE_ALERTS_KEY]; [configuration setValue:DSM_SETUP_TRUE_VALUE forKey:DSM_SETUP_DISABLE_CONTACTS_USAGE_KEY]; [DSMManager setupWithConfiguration:configuration];

See also
DSMSetupConstants.h

The documentation for this class was generated from the following file: