CMISNetworkProvider Protocol Reference
Conforms to | NSObject |
Declared in | CMISNetworkProvider.h |
Tasks
-
– invoke:httpMethod:session:body:headers:cmisRequest:completionBlock:
required method -
– invoke:httpMethod:session:inputStream:headers:cmisRequest:completionBlock:
required method -
– invoke:httpMethod:session:inputStream:headers:bytesExpected:cmisRequest:completionBlock:progressBlock:
required method -
– invoke:httpMethod:session:inputStream:headers:bytesExpected:cmisRequest:cmisProperties:mimeType:completionBlock:progressBlock:
required method -
– invoke:httpMethod:session:outputStream:bytesExpected:cmisRequest:completionBlock:progressBlock:
required method -
– invoke:httpMethod:session:outputStream:bytesExpected:offset:length:cmisRequest:completionBlock:progressBlock:
required method -
– invokeGET:session:cmisRequest:completionBlock:
required method -
– invokePOST:session:body:headers:cmisRequest:completionBlock:
required method -
– invokePUT:session:body:headers:cmisRequest:completionBlock:
required method -
– invokeDELETE:session:cmisRequest:completionBlock:
required method
Instance Methods
invoke:httpMethod:session:body:headers:cmisRequest:completionBlock:
A general invoke method, typically used for GET, DELETE HTTP methods
- (void)invoke:(NSURL *)url httpMethod:(CMISHttpRequestMethod)httpRequestMethod session:(CMISBindingSession *)session body:(NSData *)body headers:(NSDictionary *)additionalHeaders cmisRequest:(CMISRequest *)cmisRequest completionBlock:(void ( ^ ) ( CMISHttpResponse *httpResponse , NSError *error ))completionBlock
Parameters
- url
the RESTful API URL to be used @param httpRequestMethod @param session
- body
the data for the upload (maybe nil)
- completionBlock
returns an instance of the HTTPResponse if successful or nil otherwise
- headers
any additional headers to be used in the request (maybe nil)
- requestObject
a handle to the CMISRequest allowing this HTTP request to be cancelled
Discussion
A general invoke method, typically used for GET, DELETE HTTP methods
Declared In
CMISNetworkProvider.h
invoke:httpMethod:session:inputStream:headers:bytesExpected:cmisRequest:cmisProperties:mimeType:completionBlock:progressBlock:
Invoke method used for uploads, i.e. POST/PUT requests. This method is used for encoding base64 data while streaming
- (void)invoke:(NSURL *)url httpMethod:(CMISHttpRequestMethod)httpRequestMethod session:(CMISBindingSession *)session inputStream:(NSInputStream *)inputStream headers:(NSDictionary *)additionalHeaders bytesExpected:(unsigned long long)bytesExpected cmisRequest:(CMISRequest *)cmisRequest cmisProperties:(CMISProperties *)cmisProperties mimeType:(NSString *)mimeType completionBlock:(void ( ^ ) ( CMISHttpResponse *httpResponse , NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesDownloaded , unsigned long long bytesTotal ))progressBlock
Parameters
- url
the RESTful API URL to be used @param httpRequestMethod @param session
- inputStream
the stream pointing to the source to be uploaded. Must be an instance or extension of NSInputStream
- bytesExpected
the size of the content to be uploaded
- cmisRequest
will be used to set the cancellable request to the one created by the invoked method @param cmisProperties @param mimeType
- completionBlock
returns an instance of the HTTPResponse if successful or nil otherwise @param progressBlock
- requestObject
a handle to the CMISRequest allowing this HTTP request to be cancelled
- headers
any additional headers to be used in the request (maybe nil)
Discussion
Invoke method used for uploads, i.e. POST/PUT requests. This method is used for encoding base64 data while streaming
Declared In
CMISNetworkProvider.h
invoke:httpMethod:session:inputStream:headers:bytesExpected:cmisRequest:completionBlock:progressBlock:
Invoke method used for uploads, i.e. POST/PUT requests
- (void)invoke:(NSURL *)url httpMethod:(CMISHttpRequestMethod)httpRequestMethod session:(CMISBindingSession *)session inputStream:(NSInputStream *)inputStream headers:(NSDictionary *)additionalHeaders bytesExpected:(unsigned long long)bytesExpected cmisRequest:(CMISRequest *)cmisRequest completionBlock:(void ( ^ ) ( CMISHttpResponse *httpResponse , NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesDownloaded , unsigned long long bytesTotal ))progressBlock
Parameters
- url
the RESTful API URL to be used @param httpRequestMethod @param session
- inputStream
the stream pointing to the source to be uploaded. Must be an instance or extension of NSInputStream
- bytesExpected
the size of the content to be uploaded
- completionBlock
returns an instance of the HTTPResponse if successful or nil otherwise @param progressBlock
- headers
any additional headers to be used in the request (maybe nil)
- requestObject
a handle to the CMISRequest allowing this HTTP request to be cancelled
Discussion
Invoke method used for uploads, i.e. POST/PUT requests
Declared In
CMISNetworkProvider.h
invoke:httpMethod:session:inputStream:headers:cmisRequest:completionBlock:
Invoke method used for uploads, i.e. POST/PUT requests
- (void)invoke:(NSURL *)url httpMethod:(CMISHttpRequestMethod)httpRequestMethod session:(CMISBindingSession *)session inputStream:(NSInputStream *)inputStream headers:(NSDictionary *)additionalHeaders cmisRequest:(CMISRequest *)cmisRequest completionBlock:(void ( ^ ) ( CMISHttpResponse *httpResponse , NSError *error ))completionBlock
Parameters
- url
the RESTful API URL to be used @param httpRequestMethod @param session
- inputStream
the stream pointing to the source to be uploaded. Must be an instance or extension of NSInputStream
- completionBlock
returns an instance of the HTTPResponse if successful or nil otherwise
- headers
any additional headers to be used in the request (maybe nil)
- requestObject
a handle to the CMISRequest allowing this HTTP request to be cancelled
Discussion
Invoke method used for uploads, i.e. POST/PUT requests
Declared In
CMISNetworkProvider.h
invoke:httpMethod:session:outputStream:bytesExpected:cmisRequest:completionBlock:progressBlock:
Invoke method used for downloads,
- (void)invoke:(NSURL *)url httpMethod:(CMISHttpRequestMethod)httpRequestMethod session:(CMISBindingSession *)session outputStream:(NSOutputStream *)outputStream bytesExpected:(unsigned long long)bytesExpected cmisRequest:(CMISRequest *)cmisRequest completionBlock:(void ( ^ ) ( CMISHttpResponse *httpResponse , NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesDownloaded , unsigned long long bytesTotal ))progressBlock
Parameters
- url
the RESTful API URL to be used @param httpRequestMethod @param session
- outputStream
the stream pointing to the destination. Must be an instance or extension of NSOutputStream
- bytesExpected
the size of the content to be downloaded
- completionBlock
returns an instance of the HTTPResponse if successful or nil otherwise @param progressBlock
- requestObject
a handle to the CMISRequest allowing this HTTP request to be cancelled
Discussion
Invoke method used for downloads,
Declared In
CMISNetworkProvider.h
invoke:httpMethod:session:outputStream:bytesExpected:offset:length:cmisRequest:completionBlock:progressBlock:
Invoke method used for downloads,
- (void)invoke:(NSURL *)url httpMethod:(CMISHttpRequestMethod)httpRequestMethod session:(CMISBindingSession *)session outputStream:(NSOutputStream *)outputStream bytesExpected:(unsigned long long)bytesExpected offset:(NSDecimalNumber *)offset length:(NSDecimalNumber *)length cmisRequest:(CMISRequest *)cmisRequest completionBlock:(void ( ^ ) ( CMISHttpResponse *httpResponse , NSError *error ))completionBlock progressBlock:(void ( ^ ) ( unsigned long long bytesDownloaded , unsigned long long bytesTotal ))progressBlock
Parameters
- url
the RESTful API URL to be used @param httpRequestMethod @param session
- outputStream
the stream pointing to the destination. Must be an instance or extension of NSOutputStream
- bytesExpected
the size of the content to be downloaded
- offset
the offset of the stream or null to read the stream from the beginning
- completionBlock
returns an instance of the HTTPResponse if successful or nil otherwise @param progressBlock
- legnth
the maximum length of the stream or null to read to the end of the stream
- requestObject
a handle to the CMISRequest allowing this HTTP request to be cancelled
Discussion
Invoke method used for downloads,
Declared In
CMISNetworkProvider.h
invokeDELETE:session:cmisRequest:completionBlock:
Convenience DELETE invoke method
- (void)invokeDELETE:(NSURL *)url session:(CMISBindingSession *)session cmisRequest:(CMISRequest *)cmisRequest completionBlock:(void ( ^ ) ( CMISHttpResponse *httpResponse , NSError *error ))completionBlock
Parameters
- url
the RESTful API URL to be used @param session
- completionBlock
returns an instance of the HTTPResponse if successful or nil otherwise
- requestObject
a handle to the CMISRequest allowing this HTTP request to be cancelled
Discussion
Convenience DELETE invoke method
Declared In
CMISNetworkProvider.h
invokeGET:session:cmisRequest:completionBlock:
Convenience GET invoke method
- (void)invokeGET:(NSURL *)url session:(CMISBindingSession *)session cmisRequest:(CMISRequest *)cmisRequest completionBlock:(void ( ^ ) ( CMISHttpResponse *httpResponse , NSError *error ))completionBlock
Parameters
- url
the RESTful API URL to be used @param session
- completionBlock
returns an instance of the HTTPResponse if successful or nil otherwise
- requestObject
a handle to the CMISRequest allowing this HTTP request to be cancelled
Discussion
Convenience GET invoke method
Declared In
CMISNetworkProvider.h
invokePOST:session:body:headers:cmisRequest:completionBlock:
Convenience POST invoke method. Use for creating new content
- (void)invokePOST:(NSURL *)url session:(CMISBindingSession *)session body:(NSData *)body headers:(NSDictionary *)additionalHeaders cmisRequest:(CMISRequest *)cmisRequest completionBlock:(void ( ^ ) ( CMISHttpResponse *httpResponse , NSError *error ))completionBlock
Parameters
- url
the RESTful API URL to be used @param session
- body
the data to be posted
- additionalHeaders
any additional headers to be used in the request (optional)
- completionBlock
returns an instance of the HTTPResponse if successful or nil otherwise
- requestObject
a handle to the CMISRequest allowing this HTTP request to be cancelled
Discussion
Convenience POST invoke method. Use for creating new content
Declared In
CMISNetworkProvider.h
invokePUT:session:body:headers:cmisRequest:completionBlock:
Convenience PUT invoke method. Use for updating existing content
- (void)invokePUT:(NSURL *)url session:(CMISBindingSession *)session body:(NSData *)body headers:(NSDictionary *)additionalHeaders cmisRequest:(CMISRequest *)cmisRequest completionBlock:(void ( ^ ) ( CMISHttpResponse *httpResponse , NSError *error ))completionBlock
Parameters
- url
the RESTful API URL to be used @param session
- body
the data to be uploaded
- additionalHeaders
any additional headers to be used in the request (optional)
- completionBlock
returns an instance of the HTTPResponse if successful or nil otherwise
- requestObject
a handle to the CMISRequest allowing this HTTP request to be cancelled
Discussion
Convenience PUT invoke method. Use for updating existing content
Declared In
CMISNetworkProvider.h