Class FileOpenService

Multi-provider note: callers running under a non-default IMetadataProvider (multi-server clients) should set service.Provider = component.ProviderToUse from a parent component before invoking any methods.

Index

Constructors

constructor

new FileOpenService(): FileOpenService
Returns FileOpenService

Accessors

Provider

get Provider(): IMetadataProvider
Returns IMetadataProvider
- Defined in Generic/file-storage/src/lib/file-open.service.ts:31
set Provider(value: IMetadataProvider | null): void
Parameters
- value: IMetadataProvider | null
Returns void
- Defined in Generic/file-storage/src/lib/file-open.service.ts:34

Methods

OpenFile

OpenFile(accountId: string, path: string, objectId?: string): Promise<boolean>
Open a file from a storage provider in a new browser tab. Generates a pre-authenticated download URL and opens it.
Parameters
- accountId: string
  The FileStorageAccount ID
- path: string
  The file path within the storage account
- OptionalobjectId: string
  Optional provider-specific object ID (e.g., Box file ID). When provided, uses this instead of path for faster resolution.
Returns Promise<boolean>
true if the file was opened successfully
- Defined in Generic/file-storage/src/lib/file-open.service.ts:57

OpenFileFromSearchResult

OpenFileFromSearchResult(rawMetadata: string | undefined): Promise<boolean>
Open a file from search result metadata. Extracts accountId and objectId/path from the RawMetadata JSON string.
Parameters
- rawMetadata: string | undefined
  JSON string from SearchResultItem.RawMetadata
Returns Promise<boolean>
true if the file was opened successfully, false if metadata was invalid or open failed
- Defined in Generic/file-storage/src/lib/file-open.service.ts:81

OpenPreviewFromSearchResult

OpenPreviewFromSearchResult(rawMetadata: string | undefined): boolean
Open a file for preview in the provider's web viewer (if available). Falls back to download URL if no preview URL can be constructed.

Currently supported:
- Box.com: https://app.box.com/file/{fileId}
- Google Drive: https://drive.google.com/file/d/{fileId}/view
- SharePoint: Uses webUrl from provider data
- Dropbox: https://www.dropbox.com/preview/{path}
Parameters
- rawMetadata: string | undefined
  JSON string from SearchResultItem.RawMetadata
Returns boolean
true if a preview was opened
- Defined in Generic/file-storage/src/lib/file-open.service.ts:118

Class FileOpenService

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns FileOpenService

Accessors

Provider

Returns IMetadataProvider

Parameters

Returns void

Methods

OpenFile

Parameters

Returns Promise<boolean>

OpenFileFromSearchResult

Parameters

Returns Promise<boolean>

OpenPreviewFromSearchResult

Parameters

Returns boolean

Settings

On This Page