Skip to content

Latest commit

 

History

History
74 lines (62 loc) · 5.05 KB

content.service.md

File metadata and controls

74 lines (62 loc) · 5.05 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

  • getContentUrl(node: NodeEntry|string, attachment?: boolean, ticket?: string): string
    Gets a content URL for the given node.
    • node: NodeEntry|string - Node or Node ID 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 or null
  • getDocumentThumbnailUrl(nodeId: string, attachment?: boolean, ticket?: string): string
    (
    • nodeId: string -
    • attachment: boolean - (Optional) Toggles whether to retrieve content as an attachment for download
    • ticket: string - (Optional) Custom ticket to use for authentication
    • Returns string -
  • 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, userId?: string): boolean
    Checks if the user has permission on that node
    • node: Node - Node to check permissions
    • permission: PermissionsEnum|string - Required permission type
    • userId: string - (Optional) Optional current user id will be taken by default
    • 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