JSLib Reference Manual / Exports / SBFile

Class: SBFile#

SBFile

Hierarchy#

SBMessage

↳ SBFile

Table of contents#

Constructors#

constructor#

• new SBFile(channel, file)

Parameters#

Name	Type
`channel`	`Channel`
`file`	`File`

Overrides#

SBMessage.constructor

Properties#

MAX_SB_BODY_SIZE#

• MAX_SB_BODY_SIZE: number

Inherited from#

SBMessage.MAX_SB_BODY_SIZE

[SB_MESSAGE_SYMBOL]#

• [SB_MESSAGE_SYMBOL]: boolean = true

Inherited from#

SBMessage.[SB_MESSAGE_SYMBOL]

channel#

• channel: Channel

Inherited from#

SBMessage.channel

contents#

• contents: SBMessageContents

Inherited from#

SBMessage.contents

data#

• data: Dictionary<string>

image#

• image: string = ''

imageMetaData#

• imageMetaData: ImageMetaData = {}

image_sign#

• image_sign: string = ''

ready#

• ready: Promise<SBMessage>

Inherited from#

SBMessage.ready

Methods#

#asImage#

▸ Private #asImage(image, signKey): Promise<void>

Parameters#

Name	Type
`image`	`File`
`signKey`	`CryptoKey`

Returns#

Promise<void>

send#

▸ send(): Promise<string>

SBMessage.send()

Returns#

Promise<string>

Inherited from#

SBMessage.send