Share via

3.3.4.1.4.1 Methods

  • Article

sRequestUpload: This method is used for server to server interactions as an alternate method for upload initiation, and SHOULD NOT be called by a client.

  • fileLength (Int64): The size of the content file to be uploaded.

  • cookie (Int32): The unique cookie value that corresponds to the content to be created.

  • manifestXml (String): The XML placed in OcpManifest.xml.

sRequestUpload: This method is called by a client to initiate the upload of an OC package. The client MUST pass the packed and unpacked size of the package file to be uploaded, and the cookie associated with the content to be created. This cookie is used to identify various uploads. After this call, the client MUST wait for a response from the server, as described in section 3.2.4.1.4.1.

  • packedLength (Int64): The packed size of the content package file to be uploaded.

  • unpackedLength (Int64): The unpacked size of the content package file to be uploaded.

  • cookie (Int32): The unique cookie value that corresponds to the content to be created.

sUploadFinished: This method MUST be called by the client upon completion of the upload and provide the same cookie as provided in sRequestUpload. This covers the cases where the client uploaded all the data and where the client cancels the upload.

  • cookie (Int32): The unique cookie value that corresponds to the content.

  • cancel (Boolean): When "false", the user uploaded all the data. When "true", the server MUST cancel the upload.

sRequestWebUploadBlob<25>: This method is called by a client to initiate the upload of a single file using HTTPS Form POST request. The client MUST pass the OC package manifest content and the cookie associated with the content to be created. This cookie is used to identify various uploads. After this call, the client MUST wait for a response from the server, as described in section 3.2.4.1.4.1.

  • cookie (Int32): The unique cookie value that corresponds to the content to be created.

  • manifestXml (String): The XML placed in OcpManifest.xml file of OC package.

sRequestWebDownloadBlob<26>: This method is primarily for web clients to download a single file over HTTPS with decrypted content. Used whenever the client does not support decryption. After this call, the client MUST wait for a response from the server, as described in section 3.2.4.1.4.1

  • cookie (Int32): The unique cookie value that corresponds to the content.

  • obfuscatedName(String): The original encrypted file name sent from the server, to the client using the cSetNativeFileInfo method, as described in section 3.2.4.1.6.1

  • isAttachment (Boolean): True if the server puts the following HTTP response headers when delivering the file to the client:

    ContentType: application/x-download

    Content-Disposition:  attachment; filename="filename"