Inherits from NSObject
Conforms to AlfrescoSession
Declared in AlfrescoCloudSession.h

Overview

The AlfrescoCloudSession manages the session on Alfresco Cloud.

Author: Gavin Cornwell (Alfresco), Tijs Rademakers (Alfresco), Peter Schmidt (Alfresco)

Tasks

  •   oauthData

    There is a custom setter method of oauthData, which is used for refreshing access tokens. This resets the authentication and CMIS session. For initialising a AlfrescoCloudSession, one of the connectWithOAuthData methods must be used. @param oauthData

    property
  • + connectWithOAuthData:completionBlock:

    This initialiser uses OAuth authentication processes. It will only be successful if the AlfrescoOAuthData contain a valid access and refresh token. Therefore, this method should only be used after the initial OAuth setup is complete. The method well set the home network/tenant ID as default @param oauthData @param completionBlock

  • + connectWithOAuthData:parameters:completionBlock:

    This initialiser uses OAuth authentication processes. It will only be successful if the AlfrescoOAuthData contain a valid access and refresh token. Therefore, this method should only be used after the initial OAuth setup is complete. The method well set the home network/tenant ID as default @param oauthData

  • + connectWithOAuthData:networkIdentifer:completionBlock:

    This initialiser uses OAuth authentication processes. It will only be successful if the AlfrescoOAuthData contain a valid access and refresh token. Therefore, this method should only be used after the initial OAuth setup is complete. The method well set to the specified network/tenant ID. @param oauthData

  • + connectWithOAuthData:networkIdentifer:parameters:completionBlock:

    This initialiser uses OAuth authentication processes. It will only be successful if the AlfrescoOAuthData contain a valid access and refresh token. Therefore, this method should only be used after the initial OAuth setup is complete. The method well set to the specified network/tenant ID. @param oauthData

  • – retrieveNetworksWithCompletionBlock:

    This method obtains a list of available Cloud networks (or domains/tenants) for the registered user.

Properties

oauthData

There is a custom setter method of oauthData, which is used for refreshing access tokens. This resets the authentication and CMIS session. For initialising a AlfrescoCloudSession, one of the connectWithOAuthData methods must be used. @param oauthData

@property (nonatomic, strong) AlfrescoOAuthData *oauthData

Discussion

There is a custom setter method of oauthData, which is used for refreshing access tokens. This resets the authentication and CMIS session. For initialising a AlfrescoCloudSession, one of the connectWithOAuthData methods must be used. @param oauthData

Declared In

AlfrescoCloudSession.h

Class Methods

connectWithOAuthData:completionBlock:

This initialiser uses OAuth authentication processes. It will only be successful if the AlfrescoOAuthData contain a valid access and refresh token. Therefore, this method should only be used after the initial OAuth setup is complete. The method well set the home network/tenant ID as default @param oauthData @param completionBlock

+ (AlfrescoRequest *)connectWithOAuthData:(AlfrescoOAuthData *)oauthData completionBlock:(AlfrescoSessionCompletionBlock)completionBlock

Discussion

This initialiser uses OAuth authentication processes. It will only be successful if the AlfrescoOAuthData contain a valid access and refresh token. Therefore, this method should only be used after the initial OAuth setup is complete. The method well set the home network/tenant ID as default @param oauthData @param completionBlock

Declared In

AlfrescoCloudSession.h

connectWithOAuthData:networkIdentifer:completionBlock:

This initialiser uses OAuth authentication processes. It will only be successful if the AlfrescoOAuthData contain a valid access and refresh token. Therefore, this method should only be used after the initial OAuth setup is complete. The method well set to the specified network/tenant ID. @param oauthData

+ (AlfrescoRequest *)connectWithOAuthData:(AlfrescoOAuthData *)oauthData networkIdentifer:(NSString *)networkIdentifier completionBlock:(AlfrescoSessionCompletionBlock)completionBlock

Parameters

networkIdentifier
  • also known as tenant ID @param completionBlock

Discussion

This initialiser uses OAuth authentication processes. It will only be successful if the AlfrescoOAuthData contain a valid access and refresh token. Therefore, this method should only be used after the initial OAuth setup is complete. The method well set to the specified network/tenant ID. @param oauthData

Declared In

AlfrescoCloudSession.h

connectWithOAuthData:networkIdentifer:parameters:completionBlock:

This initialiser uses OAuth authentication processes. It will only be successful if the AlfrescoOAuthData contain a valid access and refresh token. Therefore, this method should only be used after the initial OAuth setup is complete. The method well set to the specified network/tenant ID. @param oauthData

+ (AlfrescoRequest *)connectWithOAuthData:(AlfrescoOAuthData *)oauthData networkIdentifer:(NSString *)networkIdentifier parameters:(NSDictionary *)parameters completionBlock:(AlfrescoSessionCompletionBlock)completionBlock

Parameters

networkIdentifier
  • also known as tenant ID
parameters
  • optional, may be nil @param completionBlock

Discussion

This initialiser uses OAuth authentication processes. It will only be successful if the AlfrescoOAuthData contain a valid access and refresh token. Therefore, this method should only be used after the initial OAuth setup is complete. The method well set to the specified network/tenant ID. @param oauthData

Declared In

AlfrescoCloudSession.h

connectWithOAuthData:parameters:completionBlock:

This initialiser uses OAuth authentication processes. It will only be successful if the AlfrescoOAuthData contain a valid access and refresh token. Therefore, this method should only be used after the initial OAuth setup is complete. The method well set the home network/tenant ID as default @param oauthData

+ (AlfrescoRequest *)connectWithOAuthData:(AlfrescoOAuthData *)oauthData parameters:(NSDictionary *)parameters completionBlock:(AlfrescoSessionCompletionBlock)completionBlock

Parameters

parameters
  • optional, may be nil @param completionBlock

Discussion

This initialiser uses OAuth authentication processes. It will only be successful if the AlfrescoOAuthData contain a valid access and refresh token. Therefore, this method should only be used after the initial OAuth setup is complete. The method well set the home network/tenant ID as default @param oauthData

Declared In

AlfrescoCloudSession.h

Instance Methods

retrieveNetworksWithCompletionBlock:

This method obtains a list of available Cloud networks (or domains/tenants) for the registered user.

- (AlfrescoRequest *)retrieveNetworksWithCompletionBlock:(AlfrescoArrayCompletionBlock)completionBlock

Parameters

completionBlock

(AlfrescoArrayCompletionBlock). If successful, the block returns an NSArray object with a list of available networks - or nil if error occurs.

Discussion

This method obtains a list of available Cloud networks (or domains/tenants) for the registered user.

Declared In

AlfrescoCloudSession.h