Class GetAttachmentRequest

internal: Represents a GetAttachment request.

Hierarchy

MultiResponseServiceRequest<GetAttachmentResponse>
- GetAttachmentRequest

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new GetAttachmentRequest(service: ExchangeService, errorHandlingMode: ServiceErrorHandling): GetAttachmentRequest

Overwrites MultiResponseServiceRequest.constructor
- Defined in Core/Requests/GetAttachmentRequest.ts:75
internal

Initializes a new instance of the GetAttachmentRequest class.

Parameters
- service: ExchangeService
  
  The service.
- errorHandlingMode: ServiceErrorHandling
  
  Indicates how errors should be handled.
Returns GetAttachmentRequest

Properties

AnchorMailbox

AnchorMailbox: string

SoapFaultDetails

SoapFaultDetails: SoapFaultDetails

Private additionalProperties

additionalProperties: PropertyDefinitionBase[]

Private attachmentIds

attachmentIds: string[]

Private attachments

attachments: Attachment[]

Private bodyType

bodyType: BodyType

Accessors

AdditionalProperties

get AdditionalProperties(): PropertyDefinitionBase[]

- Defined in Core/Requests/GetAttachmentRequest.ts:52
Gets the additional properties.

value

The additional properties.

Returns PropertyDefinitionBase[]

AttachmentIds

get AttachmentIds(): string[]

- Defined in Core/Requests/GetAttachmentRequest.ts:43
Gets the attachment ids.

value

The attachment ids.

Returns string[]

Attachments

get Attachments(): Attachment[]

- Defined in Core/Requests/GetAttachmentRequest.ts:34
Gets the attachments.

value

The attachments.

Returns Attachment[]

BodyType

get BodyType(): BodyType
set BodyType(value: BodyType): void

- Defined in Core/Requests/GetAttachmentRequest.ts:61
Gets or sets the type of the body.

value

The type of the body.

Returns BodyType
- Defined in Core/Requests/GetAttachmentRequest.ts:64
Gets or sets the type of the body.

Parameters
- value: BodyType
Returns void

EmitTimeZoneHeader

get EmitTimeZoneHeader(): boolean

Overwrites ServiceRequestBase.EmitTimeZoneHeader
- Defined in Core/Requests/GetAttachmentRequest.ts:73
internal

Gets a value indicating whether the TimeZoneContext SOAP header should be emitted.

value

true if the time zone should be emitted; otherwise, false.

Returns boolean

ErrorHandlingMode

get ErrorHandlingMode(): ServiceErrorHandling

Inherited from MultiResponseServiceRequest.ErrorHandlingMode
- Defined in Core/Requests/MultiResponseServiceRequest.ts:22
Returns ServiceErrorHandling

Service

get Service(): ExchangeService

Inherited from ServiceRequestBase.Service
- Defined in Core/Requests/ServiceRequestBase.ts:45
Returns ExchangeService

Methods

AddHeaders

AddHeaders(webHeaderCollection: any): void

Inherited from ServiceRequestBase.AddHeaders
- Defined in Core/Requests/ServiceRequestBase.ts:65
Parameters
- webHeaderCollection: any
Returns void

BuildResponseObjectFromJson

BuildResponseObjectFromJson(jsObject: any): any

Inherited from ServiceRequestBase.BuildResponseObjectFromJson
- Defined in Core/Requests/ServiceRequestBase.ts:123
Parameters
- jsObject: any
Returns any

BuildXHR

BuildXHR(): IXHROptions

Inherited from ServiceRequestBase.BuildXHR
- Defined in Core/Requests/ServiceRequestBase.ts:84
Returns IXHROptions

CreateServiceResponse

CreateServiceResponse(service: ExchangeService, responseIndex: number): GetAttachmentResponse

Overwrites MultiResponseServiceRequest.CreateServiceResponse
- Defined in Core/Requests/GetAttachmentRequest.ts:94
internal

Creates the service response.

Parameters
- service: ExchangeService
  
  The service.
- responseIndex: number
  
  Index of the response.
Returns GetAttachmentResponse

Service response.

EmitRequest

EmitRequest(request: IXHROptions): void

Inherited from ServiceRequestBase.EmitRequest
- Defined in Core/Requests/ServiceRequestBase.ts:132
Parameters
- request: IXHROptions
Returns void

Execute

Execute(): IPromise<ServiceResponseCollection<GetAttachmentResponse>>

Inherited from MultiResponseServiceRequest.Execute
- Defined in Core/Requests/MultiResponseServiceRequest.ts:32
Returns IPromise<ServiceResponseCollection<GetAttachmentResponse>>

GetEwsHttpWebResponse

GetEwsHttpWebResponse(request: IXHROptions): IPromise<XMLHttpRequest>

Inherited from ServiceRequestBase.GetEwsHttpWebResponse
- Defined in Core/Requests/ServiceRequestBase.ts:151
Parameters
- request: IXHROptions
Returns IPromise<XMLHttpRequest>

GetExpectedResponseMessageCount

GetExpectedResponseMessageCount(): number

Overwrites MultiResponseServiceRequest.GetExpectedResponseMessageCount
- Defined in Core/Requests/GetAttachmentRequest.ts:103
internal

Gets the expected response message count.

Returns number

Number of expected response messages.

GetMinimumRequiredServerVersion

GetMinimumRequiredServerVersion(): ExchangeVersion

Overwrites ServiceRequestBase.GetMinimumRequiredServerVersion
- Defined in Core/Requests/GetAttachmentRequest.ts:110
internal

Gets the request version.

Returns ExchangeVersion

Earliest Exchange version in which this request is supported.

GetRequestedServiceVersionString

GetRequestedServiceVersionString(): string

Inherited from ServiceRequestBase.GetRequestedServiceVersionString
- Defined in Core/Requests/ServiceRequestBase.ts:152
Returns string

GetResponseMessageXmlElementName

GetResponseMessageXmlElementName(): string

Overwrites MultiResponseServiceRequest.GetResponseMessageXmlElementName
- Defined in Core/Requests/GetAttachmentRequest.ts:117
internal

Gets the name of the response message XML element.

Returns string

XML element name,

GetResponseXmlElementName

GetResponseXmlElementName(): string

Overwrites ServiceRequestBase.GetResponseXmlElementName
- Defined in Core/Requests/GetAttachmentRequest.ts:124
internal

Gets the name of the response XML element.

Returns string

XML element name,

GetXmlElementName

GetXmlElementName(): string

Overwrites ServiceRequestBase.GetXmlElementName
- Defined in Core/Requests/GetAttachmentRequest.ts:131
internal

Gets the name of the XML element.

Returns string

XML element name,

InternalExecute

InternalExecute(): IPromise<any>

Inherited from SimpleServiceRequestBase.InternalExecute
- Defined in Core/Requests/SimpleServiceRequestBase.ts:15
Returns IPromise<any>

ParseResponse

ParseResponse(jsonBody: any): any

Inherited from MultiResponseServiceRequest.ParseResponse

Overwrites ServiceRequestBase.ParseResponse
- Defined in Core/Requests/MultiResponseServiceRequest.ts:107
Parameters
- jsonBody: any
Returns any

ParseResponseXMLJsObject

ParseResponseXMLJsObject(jsObject: any): any

Inherited from MultiResponseServiceRequest.ParseResponseXMLJsObject
- Defined in Core/Requests/MultiResponseServiceRequest.ts:64
Parameters
- jsObject: any
Returns any

Protected ProcessWebException

ProcessWebException(webException: XMLHttpRequest): void

Inherited from ServiceRequestBase.ProcessWebException
- Defined in Core/Requests/ServiceRequestBase.ts:163
Parameters
- webException: XMLHttpRequest
Returns void

ReadResponseJson

ReadResponseJson(jsObject: any): any

Inherited from SimpleServiceRequestBase.ReadResponseJson
- Defined in Core/Requests/SimpleServiceRequestBase.ts:123
Parameters
- jsObject: any
Returns any

Protected ReadResponseXmlJsObject

ReadResponseXmlJsObject(jsObject: any): any

Inherited from ServiceRequestBase.ReadResponseXmlJsObject
- Defined in Core/Requests/ServiceRequestBase.ts:277
Parameters
- jsObject: any
Returns any

ReadSoapFault

ReadSoapFault(reader: EwsServiceXmlReader): SoapFaultDetails

Inherited from ServiceRequestBase.ReadSoapFault
- Defined in Core/Requests/ServiceRequestBase.ts:292
Parameters
- reader: EwsServiceXmlReader
Returns SoapFaultDetails

ReadSoapHeader

ReadSoapHeader(jsObject: any): any

Inherited from ServiceRequestBase.ReadSoapHeader
- Defined in Core/Requests/ServiceRequestBase.ts:352
Parameters
- jsObject: any
Returns any

ThrowIfNotSupportedByRequestedServerVersion

ThrowIfNotSupportedByRequestedServerVersion(): void

Inherited from ServiceRequestBase.ThrowIfNotSupportedByRequestedServerVersion
- Defined in Core/Requests/ServiceRequestBase.ts:358
Returns void

Validate

Validate(): void

Overwrites ServiceRequestBase.Validate
- Defined in Core/Requests/GetAttachmentRequest.ts:136
internal

Validate request.

Returns void

ValidateAndEmitRequest

ValidateAndEmitRequest(request: IXHROptions): IPromise<XMLHttpRequest>

Inherited from ServiceRequestBase.ValidateAndEmitRequest
- Defined in Core/Requests/ServiceRequestBase.ts:374
Parameters
- request: IXHROptions
Returns IPromise<XMLHttpRequest>

WebRequestAsyncCallback

WebRequestAsyncCallback(webAsyncResult: any): any

Inherited from SimpleServiceRequestBase.WebRequestAsyncCallback
- Defined in Core/Requests/SimpleServiceRequestBase.ts:128
Parameters
- webAsyncResult: any
Returns any

WriteAttachmentIdXml

WriteAttachmentIdXml(writer: EwsServiceXmlWriter, attachmentId: string): void

- Defined in Core/Requests/GetAttachmentRequest.ts:160
internal

Writes attachment id elements.

Parameters
- writer: EwsServiceXmlWriter
  
  The writer.
- attachmentId: string
  
  The attachment id.
Returns void

WriteAttributesToXml

WriteAttributesToXml(writer: EwsServiceXmlWriter): void

Inherited from ServiceRequestBase.WriteAttributesToXml
- Defined in Core/Requests/ServiceRequestBase.ts:455
Parameters
- writer: EwsServiceXmlWriter
Returns void

WriteBodyToXml

WriteBodyToXml(writer: EwsServiceXmlWriter): void

Inherited from ServiceRequestBase.WriteBodyToXml
- Defined in Core/Requests/ServiceRequestBase.ts:460
Parameters
- writer: EwsServiceXmlWriter
Returns void

WriteElementsToXml

WriteElementsToXml(writer: EwsServiceXmlWriter): void

Overwrites ServiceRequestBase.WriteElementsToXml
- Defined in Core/Requests/GetAttachmentRequest.ts:171
internal

Writes XML elements.

Parameters
- writer: EwsServiceXmlWriter
  
  The writer.
Returns void

WriteToXml

WriteToXml(writer: EwsServiceXmlWriter): void

Inherited from ServiceRequestBase.WriteToXml
- Defined in Core/Requests/ServiceRequestBase.ts:472
Parameters
- writer: EwsServiceXmlWriter
Returns void

Generated using TypeDoc