getAlbums(params?: GetAlbumsParams)

Requires:
@ray-js/lock-sdk≥1.0.0

Description

Get album logs

Parameters

ParameterTypeRequiredDescription
NoInput parameters

Return Value

Type: Promise<GetAlbumsResult>
Paginated album log list
GetAlbumsResult
PropertyTypeDescription
hasMorebooleanHas more
Log data
typesnumber[]Event type list

Referenced Types

interfaceAlbumMessage
PropertyTypeDescription
idstringMessage ID
AI event list
aiTypesnumber[]AI type aggregation
describestringMessage content
typenumberBusiness message type
createTimenumberCreation time (ms)
mediaPathstringLogical media path
fileKeystringObject storage file key
fileUrlstringAccessible URL
mediaBucketstringBucket name
mediaKeystringMedia object key
widthnumberImage width
heightnumberImage height
anglenumberImage angle
positionnumberCamera position
isVRbooleanWhether VR mode is enabled

Examples

import { getAlbums } from '@ray-js/lock-sdk';
const albums = await getAlbums({ offset: 0, limit: 20 });