IPWorks Cloud 2020 iOS Edition

Questions / Feedback?

getDownloadAuthToken (method)

Create a download authorization token for one or more files in a bucket.

Syntax

- (NSString*)getDownloadAuthToken:(NSString*)allowedBucketId :(NSString*)allowedPrefix :(int)validityDuration;
public func getDownloadAuthToken(_ allowedBucketId: String, _ allowedPrefix: String, _ validityDuration: Int32) throws -> String

Remarks

This method creates and returns a download authorization token for the files in the bucket specified by AllowedBucketId whose names start with AllowedPrefix. The newly-created token will remain valid for the number of seconds specified by ValidityDuration, which must be a value in the range 1 to 604800 (1 week), inclusive.

Download authorization tokens created using this method can be used by anybody to download an applicable file by name; they cannot be used to download a file by Id. Refer to the DownloadFile method for more information.

The currently-authenticated application key must have the shareFiles capability to call this method successfully, otherwise the server will return an error. Refer to the AccountCapabilities property for more information.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 iOS Edition - Version 20.0 [Build 8265]