@auvious/snapshot / Snapshot

Class: Snapshot

Implements

• ISnapshot

Table of contents

Constructors

• constructor

Properties

• id
• mSignedUrl
• mSignedUrlObservable
• refreshTimer
• refreshing
• requesterUserEndpointId
• requesterUserId
• signedUrlProvider
• state
• timestamp
• type
• userEndpointId
• userId

Accessors

• approved
• discarded
• signedUrl

Methods

• isExpired
• refreshSignedUrl
• scheduleProactiveRefresh
• createFromAcquiredEvent
• createFromSnapshotDTO

Constructors

constructor

• new Snapshot(id, type, requesterUserId, requesterUserEndpointId, userId, userEndpointId, state, timestamp, signedUrlProvider): Snapshot

Parameters

Name	Type
id	string
type	string
requesterUserId	string
requesterUserEndpointId	string
userId	string
userEndpointId	string
state	SnapshotState
timestamp	Date
signedUrlProvider	SignedUrlProvider

Returns

Snapshot

Properties

id

• id: string

Implementation of

ISnapshot.id

---

mSignedUrl

• Private mSignedUrl: SignedUrl

---

mSignedUrlObservable

• Private mSignedUrlObservable: Subject<string>

---

refreshTimer

• Private refreshTimer: Timeout = null

---

refreshing

• Private refreshing: boolean = false

---

requesterUserEndpointId

• requesterUserEndpointId: string

Implementation of

ISnapshot.requesterUserEndpointId

---

requesterUserId

• requesterUserId: string

Implementation of

ISnapshot.requesterUserId

---

signedUrlProvider

• Private signedUrlProvider: SignedUrlProvider

---

state

• state: SnapshotState

Implementation of

ISnapshot.state

---

timestamp

• timestamp: Date

---

type

• Optional type: string

Implementation of

ISnapshot.type

---

userEndpointId

• userEndpointId: string

Implementation of

ISnapshot.userEndpointId

---

userId

• userId: string

Implementation of

ISnapshot.userId

Accessors

approved

• get approved(): boolean

Returns

boolean

Implementation of

ISnapshot.approved

---

discarded

• get discarded(): boolean

Returns

boolean

---

signedUrl

• get signedUrl(): Observable<string>

Returns

Observable<string>

Implementation of

ISnapshot.signedUrl

Methods

isExpired

▸ isExpired(): boolean

Returns

boolean

---

refreshSignedUrl

▸ refreshSignedUrl(): Promise<void>

Returns

Promise<void>

---

scheduleProactiveRefresh

▸ scheduleProactiveRefresh(): void

Returns

void

---

createFromAcquiredEvent

▸ createFromAcquiredEvent(event, signedUrlProvider): ISnapshot

Parameters

Name	Type
event	SnapshotAcquiredEvent
signedUrlProvider	SignedUrlProvider

Returns

ISnapshot

---

createFromSnapshotDTO

▸ createFromSnapshotDTO(dto, signedUrlProvider): ISnapshot

Parameters

Name	Type
dto	ISnapshotDTO
signedUrlProvider	SignedUrlProvider

Returns

ISnapshot