Class Media

Hierarchy

APIResource
- Media

Index

Constructors

Properties

Methods

createAlbum deleteAlbum deleteMedia downloadMedia getAlbumDetail getMedia getMediaSupport listAlbums listMedia updateAlbum

Constructors

constructor

new Media(client: GboxClient): GboxClient.V1.Boxes.Media
Parameters
- client: GboxClient
Returns GboxClient.V1.Boxes.Media
Inherited from APIResource.constructor
- Defined in src/core/resource.ts:8

Properties

`Protected`_client

_client: GboxClient

Methods

createAlbum

createAlbum(
    boxID: string,
    body: GboxClient.V1.Boxes.MediaCreateAlbumParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.MediaAlbum>
Create a new album with media files
Parameters
- boxID: string
- body: GboxClient.V1.Boxes.MediaCreateAlbumParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.MediaAlbum>
Example
```
const mediaAlbum = await client.v1.boxes.media.createAlbum(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  { name: 'Vacation Photos' },
);
```
- Defined in src/resources/v1/boxes/media.ts:23

deleteAlbum

deleteAlbum(
    albumName: string,
    params: GboxClient.V1.Boxes.MediaDeleteAlbumParams,
    options?: RequestOptions,
): APIPromise<void>
Delete an album and all its media files
Parameters
- albumName: string
- params: GboxClient.V1.Boxes.MediaDeleteAlbumParams
- Optionaloptions: RequestOptions
Returns APIPromise<void>
Example
```
await client.v1.boxes.media.deleteAlbum('Pictures', {
  boxId: 'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
});
```
- Defined in src/resources/v1/boxes/media.ts:40

deleteMedia

deleteMedia(
    mediaName: string,
    params: GboxClient.V1.Boxes.MediaDeleteMediaParams,
    options?: RequestOptions,
): APIPromise<void>
Delete a specific media file from an album
Parameters
- mediaName: string
- params: GboxClient.V1.Boxes.MediaDeleteMediaParams
- Optionaloptions: RequestOptions
Returns APIPromise<void>
Example
```
await client.v1.boxes.media.deleteMedia('IMG_001.jpg', {
  boxId: 'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  albumName: 'Pictures',
});
```
- Defined in src/resources/v1/boxes/media.ts:59

downloadMedia

downloadMedia(
    mediaName: string,
    params: GboxClient.V1.Boxes.MediaDownloadMediaParams,
    options?: RequestOptions,
): APIPromise<Response>
Download a specific media file from an album
Parameters
- mediaName: string
- params: GboxClient.V1.Boxes.MediaDownloadMediaParams
- Optionaloptions: RequestOptions
Returns APIPromise<Response>
Example
```
const response = await client.v1.boxes.media.downloadMedia(
  'IMG_001.jpg',
  {
    boxId: 'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
    albumName: 'Pictures',
  },
);

const content = await response.blob();
console.log(content);
```
- Defined in src/resources/v1/boxes/media.ts:84

getAlbumDetail

getAlbumDetail(
    albumName: string,
    params: GboxClient.V1.Boxes.MediaGetAlbumDetailParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.MediaAlbum>
Get detailed information about a specific album including its media files
Parameters
- albumName: string
- params: GboxClient.V1.Boxes.MediaGetAlbumDetailParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.MediaAlbum>
Example
```
const mediaAlbum =
  await client.v1.boxes.media.getAlbumDetail('Pictures', {
    boxId: 'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  });
```
- Defined in src/resources/v1/boxes/media.ts:108

getMedia

getMedia(
    mediaName: string,
    params: GboxClient.V1.Boxes.MediaGetMediaParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.MediaGetMediaResponse>
Get detailed information about a specific media file
Parameters
- mediaName: string
- params: GboxClient.V1.Boxes.MediaGetMediaParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.MediaGetMediaResponse>
Example
```
const response = await client.v1.boxes.media.getMedia(
  'IMG_001.jpg',
  {
    boxId: 'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
    albumName: 'Pictures',
  },
);
```
- Defined in src/resources/v1/boxes/media.ts:131

getMediaSupport

getMediaSupport(
boxID: string,
options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.MediaGetMediaSupportResponse>
Get supported media file extensions for photos and videos
Parameters
- boxID: string
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.MediaGetMediaSupportResponse>
Example
```
const response =
  await client.v1.boxes.media.getMediaSupport(
    'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
  );
```
- Defined in src/resources/v1/boxes/media.ts:151

listAlbums

listAlbums(
boxID: string,
options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.MediaListAlbumsResponse>
Get a list of albums in the box
Parameters
- boxID: string
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.MediaListAlbumsResponse>
Example
```
const response = await client.v1.boxes.media.listAlbums(
  'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
);
```
- Defined in src/resources/v1/boxes/media.ts:165

listMedia

listMedia(
    albumName: string,
    params: GboxClient.V1.Boxes.MediaListMediaParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.MediaListMediaResponse>
Get a list of media files in a specific album
Parameters
- albumName: string
- params: GboxClient.V1.Boxes.MediaListMediaParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.MediaListMediaResponse>
Example
```
const response = await client.v1.boxes.media.listMedia(
  'Pictures',
  { boxId: 'c9bdc193-b54b-4ddb-a035-5ac0c598d32d' },
);
```
- Defined in src/resources/v1/boxes/media.ts:180

updateAlbum

updateAlbum(
    albumName: string,
    params: GboxClient.V1.Boxes.MediaUpdateAlbumParams,
    options?: RequestOptions,
): APIPromise<GboxClient.V1.Boxes.MediaAlbum>
Add media files to an existing album
Parameters
- albumName: string
- params: GboxClient.V1.Boxes.MediaUpdateAlbumParams
- Optionaloptions: RequestOptions
Returns APIPromise<GboxClient.V1.Boxes.MediaAlbum>
Example
```
const mediaAlbum = await client.v1.boxes.media.updateAlbum(
  'Pictures',
  {
    boxId: 'c9bdc193-b54b-4ddb-a035-5ac0c598d32d',
    media: [fs.createReadStream('path/to/file')],
  },
);
```
- Defined in src/resources/v1/boxes/media.ts:203

Class Media

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GboxClient.V1.Boxes.Media

Properties

Protected_client

Methods

createAlbum

Parameters

Returns APIPromise<GboxClient.V1.Boxes.MediaAlbum>

Example

deleteAlbum

Parameters

Returns APIPromise<void>

Example

deleteMedia

Parameters

Returns APIPromise<void>

Example

downloadMedia

Parameters

Returns APIPromise<Response>

Example

getAlbumDetail

Parameters

Returns APIPromise<GboxClient.V1.Boxes.MediaAlbum>

Example

getMedia

Parameters

Returns APIPromise<GboxClient.V1.Boxes.MediaGetMediaResponse>

Example

getMediaSupport

Parameters

Returns APIPromise<GboxClient.V1.Boxes.MediaGetMediaSupportResponse>

Example

listAlbums

Parameters

Returns APIPromise<GboxClient.V1.Boxes.MediaListAlbumsResponse>

Example

listMedia

Parameters

Returns APIPromise<GboxClient.V1.Boxes.MediaListMediaResponse>

Example

updateAlbum

Parameters

Returns APIPromise<GboxClient.V1.Boxes.MediaAlbum>

Example

Settings

On This Page

`Protected`_client