Skip to content

Latest commit

 

History

History
98 lines (86 loc) · 7.63 KB

content.service.md

File metadata and controls

98 lines (86 loc) · 7.63 KB
Raw
Title Added Status Last reviewed
Content service
v2.0.0
Active
2019-03-13

Content service

Accesses app-generated data objects via URLs and file downloads.

Class members

Methods

  • createTrustedUrl(blob: Blob): string
    Creates a trusted object URL from the Blob. WARNING: calling this method with untrusted user data exposes your application to XSS security risks!
    • blob: Blob - Data to wrap into object URL
    • Returns string - URL string
  • downloadBlob(blob: Blob, fileName: string)
    Invokes content download for a Blob with a file name.
    • blob: Blob - Content to download.
    • fileName: string - Name of the resulting file.
  • downloadData(data: any, fileName: string)
    Invokes content download for a data array with a file name.
    • data: any - Data to download.
    • fileName: string - Name of the resulting file.
  • downloadJSON(json: any, fileName: string)
    Invokes content download for a JSON object with a file name.
    • json: any - JSON object to download.
    • fileName: string - Name of the resulting file.
  • getContentUrl(node: any, attachment?: boolean, ticket?: string): string
    Gets a content URL for the given node.
    • node: any - Node to get URL for.
    • attachment: boolean - (Optional) Toggles whether to retrieve content as an attachment for download
    • ticket: string - (Optional) Custom ticket to use for authentication
    • Returns string - URL string
  • getDocumentThumbnailUrl(node: any, attachment?: boolean, ticket?: string): string
    Gets a thumbnail URL for the given document node.
    • node: any - Node to get URL for.
    • attachment: boolean - (Optional) Toggles whether to retrieve content as an attachment for download
    • ticket: string - (Optional) Custom ticket to use for authentication
    • Returns string - URL string
  • getNode(nodeId: string, opts?: any): Observable<NodeEntry>
    Gets a Node via its node ID.
    • nodeId: string - ID of the target node
    • opts: any - (Optional) Options supported by JS-API
    • Returns Observable<NodeEntry> - Details of the folder
  • getNodeContent(nodeId: string): Observable<any>
    Gets content for the given node.
    • nodeId: string - ID of the target node
    • Returns Observable<any> - Content data
  • hasAllowableOperations(node: Node, allowableOperation: AllowableOperationsEnum|string): boolean
    Checks if the user has permissions on that node
    • node: Node - Node to check allowableOperations
    • allowableOperation: AllowableOperationsEnum|string - Create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions
    • Returns boolean - True if the user has the required permissions, false otherwise
  • hasPermissions(node: Node, permission: PermissionsEnum|string): boolean
    Checks if the user has permission on that node
    • node: Node - Node to check permissions
    • permission: PermissionsEnum|string - Required permission type
    • Returns boolean - True if the user has the required permissions, false otherwise

Details

Use the Content service to deliver data to the user from Blob objects.

The Blob class (implemented in the browser, not ADF) represents an array of bytes that you can use to construct and store data in any binary format you choose. The user can access a Blob either by downloading the byte array as a file or in some cases by viewing it directly in the browser via a special URL that references the Blob. For example, you could use the Blob interface to construct an image in the PNG format. Since PNG is a format the browser can display, you could use the Blob's URL in an <img> element to view the image within the page. Alternatively, you could let the user download it as a PNG file.

The downloadBlob method starts a download of the Blob data to the filename within the user's downloads folder. The other downloadXXX methods do the same but first convert the supplied data to a Blob before downloading; see the Blob reference page for details of how a Blob's contents are assembled from the constructor arguments.

Use createdTrustedUrl to generate a URL string for a Blob. The URL refers to the Blob as though it were a file but it is actually an object stored in memory, so it does not persist across browser sessions. This URL can be used much like any other, so you could use it for the src attribute of an <img> element or the href of a download link. Note that while the URL is 'trusted', the data it contains is not necessarily trustworthy unless you can vouch for it yourself; be careful that the data doesn't expose your app to Cross Site Scripting attacks.

See also