Rate this page:

Document

Class that represents document attachments.

Document attachments are supported for inbound and outbound messages.

Constructors

Document

Copy URL
fun Document(file: 

File

):

Creates a document attachment for a message.

Throws IllegalArgumentException if

Parameters

  • file:

    File

    File object.

Methods

equals

Copy URL
fun equals(other: 

Any?

):

Boolean

Parameters

  • other:

    Any?

    Optional

Returns

  • type:

    Boolean

hashCode

Copy URL
fun hashCode(): 

Int

Returns

  • type:

    Int

toString

Copy URL
fun toString(): 

String

Returns

  • type:

    String

Props

id

Copy URL
val id: 

Long?

Attachment id.

Available only if a message with this attachment is successfully sent.

Returns

  • type:

    Long?

mimeType

Copy URL
val mimeType: 

String

Document file MIME type.

Returns

  • type:

    String

name

Copy URL
val name: 

String

Document file name.

Returns

  • type:

    String

requestId

Copy URL
val requestId: 

String?

Temporary attachment id.

Available only if a message with this attachment is sent from an application.

Returns

  • type:

    String?

size

Copy URL
val size: 

Long

Document file size.

Returns

  • type:

    Long

url

Copy URL
val url: 

String?

URL to download the document file.

Returns

  • type:

    String?