FileAttachment | Ews JavaScript Api

Represents a file attachment.

Hierarchy

Attachment
- FileAttachment

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new FileAttachment(owner: Item): FileAttachment
new FileAttachment(service: ExchangeService): FileAttachment

Overwrites Attachment.constructor
- Defined in ComplexProperties/FileAttachment.ts:87
internal

Initializes a new instance of the FileAttachment class.

Parameters
- owner: Item
  
  The owner of the attachment.
Returns FileAttachment
Overwrites Attachment.constructor
- Defined in ComplexProperties/FileAttachment.ts:94
internal

Initializes a new instance of the FileAttachment class.

Parameters
- service: ExchangeService
  
  The service.
Returns FileAttachment

Properties

Namespace

Namespace: XmlNamespace

OnChange

OnChange: ComplexPropertyChangedDelegate[]

____implementsInterface

____implementsInterface: string[]

____typeName

____typeName: string

Private base64Content

base64Content: string

Private fileName

fileName: string

Private isContactPhoto

isContactPhoto: boolean

Accessors

Base64Content

get Base64Content(): string
set Base64Content(value: string): void

- Defined in ComplexProperties/FileAttachment.ts:67
Gets the base64 content of the attachment into memory. Content is set only when Load() is called.

Returns string
- Defined in ComplexProperties/FileAttachment.ts:70
Gets the base64 content of the attachment into memory. Content is set only when Load() is called.

Parameters
- value: string
Returns void

ContentId

get ContentId(): string
set ContentId(value: string): void

Inherited from Attachment.ContentId
- Defined in ComplexProperties/Attachment.ts:67
Gets or sets the content Id of the attachment. ContentId can be used as a custom way to identify an attachment in order to reference it from within the body of the item the attachment belongs to.

Returns string
Inherited from Attachment.ContentId
- Defined in ComplexProperties/Attachment.ts:70
Gets or sets the content Id of the attachment. ContentId can be used as a custom way to identify an attachment in order to reference it from within the body of the item the attachment belongs to.

Parameters
- value: string
Returns void

ContentLocation

get ContentLocation(): string
set ContentLocation(value: string): void

Inherited from Attachment.ContentLocation
- Defined in ComplexProperties/Attachment.ts:77
Gets or sets the content location of the attachment. ContentLocation can be used to associate an attachment with a Url defining its location on the Web.

Returns string
Inherited from Attachment.ContentLocation
- Defined in ComplexProperties/Attachment.ts:80
Gets or sets the content location of the attachment. ContentLocation can be used to associate an attachment with a Url defining its location on the Web.

Parameters
- value: string
Returns void

ContentType

get ContentType(): string
set ContentType(value: string): void

Inherited from Attachment.ContentType
- Defined in ComplexProperties/Attachment.ts:57
Gets or sets the content type of the attachment.

Returns string
Inherited from Attachment.ContentType
- Defined in ComplexProperties/Attachment.ts:60
Gets or sets the content type of the attachment.

Parameters
- value: string
Returns void

FileName

get FileName(): string
set FileName(value: string): void

- Defined in ComplexProperties/FileAttachment.ts:29
Gets the name of the file the attachment is linked to.

Returns string
- Defined in ComplexProperties/FileAttachment.ts:32
Gets the name of the file the attachment is linked to.

Parameters
- value: string
Returns void

Id

get Id(): string
set Id(value: string): void

Inherited from Attachment.Id
- Defined in ComplexProperties/Attachment.ts:37
Gets the Id of the attachment.

Returns string
Inherited from Attachment.Id
- Defined in ComplexProperties/Attachment.ts:40
Gets the Id of the attachment.

Parameters
- value: string
Returns void

IsContactPhoto

get IsContactPhoto(): boolean
set IsContactPhoto(value: boolean): void

- Defined in ComplexProperties/FileAttachment.ts:79
Gets or sets a value indicating whether this attachment is a contact photo.

Returns boolean
- Defined in ComplexProperties/FileAttachment.ts:83
Gets or sets a value indicating whether this attachment is a contact photo.

Parameters
- value: boolean
Returns void

IsInline

get IsInline(): boolean
set IsInline(value: boolean): void

Inherited from Attachment.IsInline
- Defined in ComplexProperties/Attachment.ts:111
Gets or sets a value indicating whether this is an inline attachment. Inline attachments are not visible to end users.

Returns boolean
Inherited from Attachment.IsInline
- Defined in ComplexProperties/Attachment.ts:115
Gets or sets a value indicating whether this is an inline attachment. Inline attachments are not visible to end users.

Parameters
- value: boolean
Returns void

IsNew

get IsNew(): boolean

Inherited from Attachment.IsNew
- Defined in ComplexProperties/Attachment.ts:123
internal

True if the attachment has not yet been saved, false otherwise.

Returns boolean

LastModifiedTime

get LastModifiedTime(): DateTime
set LastModifiedTime(value: DateTime): void

Inherited from Attachment.LastModifiedTime
- Defined in ComplexProperties/Attachment.ts:99
Gets the date and time when this attachment was last modified.

Returns DateTime
Inherited from Attachment.LastModifiedTime
- Defined in ComplexProperties/Attachment.ts:103
Gets the date and time when this attachment was last modified.

Parameters
- value: DateTime
Returns void

Name

get Name(): string
set Name(value: string): void

Inherited from Attachment.Name
- Defined in ComplexProperties/Attachment.ts:47
Gets or sets the name of the attachment.

Returns string
Inherited from Attachment.Name
- Defined in ComplexProperties/Attachment.ts:50
Gets or sets the name of the attachment.

Parameters
- value: string
Returns void

Owner

get Owner(): Item

Inherited from Attachment.Owner
- Defined in ComplexProperties/Attachment.ts:130
internal

Gets the owner of the attachment.

Returns Item

Service

get Service(): ExchangeService

Inherited from Attachment.Service
- Defined in ComplexProperties/Attachment.ts:137
internal

Gets the related exchange service.

Returns ExchangeService

Size

get Size(): number
set Size(value: number): void

Inherited from Attachment.Size
- Defined in ComplexProperties/Attachment.ts:87
Gets the size of the attachment.

Returns number
Inherited from Attachment.Size
- Defined in ComplexProperties/Attachment.ts:91
Gets the size of the attachment.

Parameters
- value: number
Returns void

Methods

Changed

Changed(): void

Inherited from ComplexProperty.Changed
- Defined in ComplexProperties/ComplexProperty.ts:21
Returns void

ClearChangeLog

ClearChangeLog(): void

Inherited from ComplexProperty.ClearChangeLog
- Defined in ComplexProperties/ComplexProperty.ts:31
Returns void

GetXmlElementName

GetXmlElementName(): string

Overwrites Attachment.GetXmlElementName
- Defined in ComplexProperties/FileAttachment.ts:110
internal

Gets the name of the XML element.

Returns string

XML element name.

InternalLoad

InternalLoad(bodyType: BodyType, additionalProperties: PropertyDefinitionBase[]): IPromise<void>

Inherited from Attachment.InternalLoad
- Defined in ComplexProperties/Attachment.ts:182
internal

Load the attachment.

Parameters
- bodyType: BodyType
  
  Type of the body.
- additionalProperties: PropertyDefinitionBase[]
  
  The additional properties.
Returns IPromise<void>

InternalLoadFromXmlJsObject

InternalLoadFromXmlJsObject(jsObject: any, service: ExchangeService, readAction: function): void

Inherited from ComplexProperty.InternalLoadFromXmlJsObject
- Defined in ComplexProperties/ComplexProperty.ts:32
Parameters
- jsObject: any
- service: ExchangeService
- readAction: function
  - - (jsonProperty: any, service: ExchangeService): void
    - Parameters
      - jsonProperty: any
      - service: ExchangeService
      Returns void
Returns void

InternalValidate

InternalValidate(): void

Inherited from ComplexProperty.InternalValidate
- Defined in ComplexProperties/ComplexProperty.ts:60
Returns void

Load

Load(): IPromise<void>

Inherited from Attachment.Load
- Defined in ComplexProperties/Attachment.ts:194
Loads the attachment. Calling this method results in a call to EWS.

Returns IPromise<void>

LoadFromXmlJsObject

LoadFromXmlJsObject(jsObject: any, service: ExchangeService): void

Overwrites Attachment.LoadFromXmlJsObject
- Defined in ComplexProperties/FileAttachment.ts:136
internal

Loads from XMLjsObject.

Parameters
- jsObject: any
- service: ExchangeService
Returns void

ReadAttributesFromXmlJsObject

ReadAttributesFromXmlJsObject(reader: EwsServiceXmlReader): void

Inherited from ComplexProperty.ReadAttributesFromXmlJsObject
- Defined in ComplexProperties/ComplexProperty.ts:71
Parameters
- reader: EwsServiceXmlReader
Returns void

ReadElementsFromXmlJsObject

ReadElementsFromXmlJsObject(jsonProperty: any, service: ExchangeService): void

Inherited from ComplexProperty.ReadElementsFromXmlJsObject
- Defined in ComplexProperties/ComplexProperty.ts:96
Parameters
- jsonProperty: any
- service: ExchangeService
Returns void

ReadElementsFromXmlJsObjectToPatch

ReadElementsFromXmlJsObjectToPatch(reader: any): boolean

Overwrites ComplexProperty.ReadElementsFromXmlJsObjectToPatch
- Defined in ComplexProperties/FileAttachment.ts:180
Parameters
- reader: any
Returns boolean

ReadTextValueFromXmlJsObject

ReadTextValueFromXmlJsObject(jsObject: EwsServiceXmlReader): void

Inherited from ComplexProperty.ReadTextValueFromXmlJsObject
- Defined in ComplexProperties/ComplexProperty.ts:72
Parameters
- jsObject: EwsServiceXmlReader
Returns void

SetFieldValue

SetFieldValue<T>(field: IRefParam<T>, value: T): void

Inherited from Attachment.SetFieldValue

Overwrites ComplexProperty.SetFieldValue
- Defined in ComplexProperties/Attachment.ts:262
internal

Sets value of field.

remarks

We override the base implementation. Attachments cannot be modified so any attempts the change a property on an existing attachment is an error.

Type parameters
- T
Parameters
- field: IRefParam<T>
  
  The field.
- value: T
  
  The value.
Returns void

ThrowIfThisIsNotNew

ThrowIfThisIsNotNew(): void

Inherited from Attachment.ThrowIfThisIsNotNew
- Defined in ComplexProperties/Attachment.ts:270
internal

Throws exception if this is not a new service object.

Returns void

UpdateFromXmlJsObject

UpdateFromXmlJsObject(jsObject: any, service: ExchangeService): void

Inherited from ComplexProperty.UpdateFromXmlJsObject
- Defined in ComplexProperties/ComplexProperty.ts:99
Parameters
- jsObject: any
- service: ExchangeService
Returns void

Validate

Validate(attachmentIndex?: number): void

Overwrites Attachment.Validate
- Defined in ComplexProperties/FileAttachment.ts:187
internal

Validates this instance.

Parameters
- Optional attachmentIndex: number
  
  Index of this attachment.
Returns void

WriteAttributesToXml

WriteAttributesToXml(writer: EwsServiceXmlWriter): void

Inherited from ComplexProperty.WriteAttributesToXml
- Defined in ComplexProperties/ComplexProperty.ts:115
Parameters
- writer: EwsServiceXmlWriter
Returns void

WriteElementsToXml

WriteElementsToXml(writer: EwsServiceXmlWriter): void

Overwrites Attachment.WriteElementsToXml
- Defined in ComplexProperties/FileAttachment.ts:198
internal

Writes elements and content to XML.

Parameters
- writer: EwsServiceXmlWriter
  
  The writer.
Returns void

WriteToXml

WriteToXml(writer: EwsServiceXmlWriter, xmlElementName: string, xmlNamespace?: XmlNamespace): void

Inherited from ComplexProperty.WriteToXml
- Defined in ComplexProperties/ComplexProperty.ts:118
Parameters
- writer: EwsServiceXmlWriter
- xmlElementName: string
- Optional xmlNamespace: XmlNamespace
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

owner: Item

Returns FileAttachment

Parameters

service: ExchangeService

Returns FileAttachment

Properties

Namespace

OnChange

____implementsInterface

____typeName

Private base64Content

Private fileName

Private isContactPhoto

Accessors

Base64Content

Returns string

Parameters

value: string

Returns void

ContentId

Returns string

Parameters

value: string

Returns void

ContentLocation

Returns string

Parameters

value: string

Returns void

ContentType

Returns string

Parameters

value: string

Returns void

FileName

Returns string

Parameters

value: string

Returns void

Id

Returns string

Parameters

value: string

Returns void

IsContactPhoto

Returns boolean

Parameters

value: boolean

Returns void

IsInline

Returns boolean

Parameters

value: boolean

Returns void

IsNew

Returns boolean

LastModifiedTime

Returns DateTime

Parameters

value: DateTime

Returns void

Name

Returns string

Parameters

value: string

Returns void

Owner

Returns Item

Service

Returns ExchangeService

Size