Class SubscribeRequest<TSubscription>

Not Implemented

Type parameters

TSubscription

Hierarchy

MultiResponseServiceRequest<SubscribeResponse<TSubscription>>
- SubscribeRequest

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

Inherited from MultiResponseServiceRequest.constructor

Overwrites ServiceRequestBase.constructor
- Defined in Core/Requests/MultiResponseServiceRequest.ts:23
Parameters
- service: ExchangeService
- errorHandlingMode: ServiceErrorHandling
Returns SubscribeRequest

Properties

AnchorMailbox

AnchorMailbox: string

EventTypes

EventTypes: EventType[]

FolderIds

FolderIds: FolderIdWrapperList

SoapFaultDetails

SoapFaultDetails: SoapFaultDetails

Watermark

Watermark: string

Accessors

EmitTimeZoneHeader

get EmitTimeZoneHeader(): boolean

Inherited from ServiceRequestBase.EmitTimeZoneHeader
- Defined in Core/Requests/ServiceRequestBase.ts:52
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

AddJsonProperties

AddJsonProperties(jsonSubscribeRequest: JsonObject, service: ExchangeService): void

- Defined in Core/Requests/SubscribeRequest.ts:15
Parameters
- jsonSubscribeRequest: JsonObject
- service: ExchangeService
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): SubscribeResponse<TSubscription>

Inherited from MultiResponseServiceRequest.CreateServiceResponse
- Defined in Core/Requests/MultiResponseServiceRequest.ts:30
Parameters
- service: ExchangeService
- responseIndex: number
Returns SubscribeResponse<TSubscription>

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<SubscribeResponse<TSubscription>>>

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

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/SubscribeRequest.ts:16
Returns number

GetMinimumRequiredServerVersion

GetMinimumRequiredServerVersion(): ExchangeVersion

Inherited from ServiceRequestBase.GetMinimumRequiredServerVersion
- Defined in Core/Requests/ServiceRequestBase.ts:72
Returns ExchangeVersion

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/SubscribeRequest.ts:17
Returns string

GetResponseXmlElementName

GetResponseXmlElementName(): string

Overwrites ServiceRequestBase.GetResponseXmlElementName
- Defined in Core/Requests/SubscribeRequest.ts:18
Returns string

GetSubscriptionXmlElementName

GetSubscriptionXmlElementName(): string

- Defined in Core/Requests/SubscribeRequest.ts:19
Returns string

GetXmlElementName

GetXmlElementName(): string

Overwrites ServiceRequestBase.GetXmlElementName
- Defined in Core/Requests/SubscribeRequest.ts:20
Returns string

InternalExecute

InternalExecute(): IPromise<any>

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

InternalWriteElementsToXml

InternalWriteElementsToXml(writer: EwsServiceXmlWriter): void

- Defined in Core/Requests/SubscribeRequest.ts:21
Parameters
- writer: EwsServiceXmlWriter
Returns void

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/SubscribeRequest.ts:22
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

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/SubscribeRequest.ts:23
Parameters
- writer: EwsServiceXmlWriter
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