AutodiscoverService class

Represents a binding to the Exchange Autodiscover Service.

Inheritance

• Object
• ExchangeServiceBase
• AutodiscoverService

Constructors

AutodiscoverService.withExchangeServiceAndExchangeVersion(ExchangeServiceBase service, ExchangeVersion requestedServerVersion)

Initializes a new instance of the

Properties

AcceptGzipEncoding ↔ bool

Gets or sets a value indicating whether GZip compression encoding should be accepted.

getter/setter pair, inherited

ClientRequestId ↔ String?

Gets or sets the request id for the request.

getter/setter pair, inherited

ConnectionGroupName ↔ String?

Gets or sets the name of the connection group for the request.

getter/setter pair, inherited

CookieContainer ↔ CookieContainer

Gets or sets the cookie container.

getter/setter pair, inherited

Credentials ↔ ExchangeCredentials?

Gets or sets the credentials used to authenticate with the Exchange Web Services. Setting the Credentials property automatically sets the UseDefaultCredentials to false.

getter/setter pair, inherited

Domain ↔ String?

Retrieves the specified settings for a set of users.

getter/setter pair

EnableScpLookup ↔ bool

Gets or sets the DNS server address.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

HttpHeaders → Map<String, String>

Gets or sets a flag to indicate whether the client requires the server side to return the request id.

no setter, inherited

HttpResponseHeaders → Map<String, String?>

Gets a collection of HTTP headers from the last response.

no setter, inherited

HttpWebRequestFactory ↔ IEwsHttpWebRequestFactory

Gets or sets the HTTP web request factory.

getter/setter pair, inherited

IsExternal ↔ bool

Gets a value indicating whether the Autodiscover service that URL points to is (inside the corporate network) or external (outside the corporate network).

getter/setter pair

KeepAlive ↔ bool

Gets or sets if the request to the internet resource should contain a Connection HTTP header with the value Keep-alive

getter/setter pair, inherited

OnResponseHeadersCaptured ↔ List<ResponseHeadersCapturedHandler>

Occurs when the http response headers of a server call is captured.

getter/setter pair, inherited

OnSerializeCustomSoapHeaders ↔ List<CustomXmlSerializationDelegate>

Provides an event that applications can implement to emit custom SOAP headers in requests that are sent to Exchange.

getter/setter pair, inherited

PreAuthenticate ↔ bool

Gets or sets a value that indicates whether HTTP pre-authentication should be performed.

getter/setter pair, inherited

RedirectionUrlValidationCallback ↔ AutodiscoverRedirectionUrlValidationCallback?

Gets or sets the redirection URL validation callback.

getter/setter pair

RequestedServerVersion → ExchangeVersion

Gets the requested server version.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

SendClientLatencies ↔ bool

Gets a time zone definition generated from the time zone info to which this service is scoped.

getter/setter pair, inherited

ServerInfo ↔ ExchangeServerInfo?

Gets information associated with the server that processed the last request. Will be null if no requests have been processed.

getter/setter pair, inherited

SuppressXmlVersionHeader ↔ bool

For testing: suppresses generation of the SOAP version header.

getter/setter pair, inherited

Timeout ↔ int

Gets or sets the timeout used when sending HTTP requests and when receiving HTTP responses, in milliseconds. Defaults to 100000.

getter/setter pair, inherited

TimeZone → TimeZone?

Gets the time zone this service is scoped to.

no setter, inherited

TraceEnabled ↔ bool

Gets or sets a value indicating whether tracing is enabled.

getter/setter pair, inherited

TraceFlags ↔ List<TraceFlags>

Gets or sets the trace flags.

getter/setter pair, inherited

TraceListener ↔ ITraceListener

Gets or sets the trace listener.

getter/setter pair, inherited

Url ↔ Uri?

Gets or sets the URL this service is bound to.

getter/setter pair

UseDefaultCredentials ↔ bool

Gets or sets a value indicating whether the credentials of the user currently logged into Windows should be used to authenticate with the Exchange Web Services. Setting UseDefaultCredentials to true automatically sets the Credentials property to null.

getter/setter pair, inherited

UserAgent ↔ String

Gets or sets the user agent.

getter/setter pair, inherited

WebProxt ← IWebProxy

no getter, inherited

WebProxy → IWebProxy?

Gets or sets the web proxy that should be used when sending requests to EWS. Set this property to null to use the default web proxy.

no setter, inherited

Methods

CallRedirectionUrlValidationCallback(String redirectionUrl) → bool

Creates an HttpWebRequest instance and initializes it with the appropriate parameters, based on the configuration of this service object.

ConvertDateTimeToUniversalDateTimeString(DateTime value) → String

Converts the date time to universal date time string.

inherited

ConvertStartDateToUnspecifiedDateTime(String? value) → DateTime?

Converts xs:dateTime String with either "Z", "-00:00" bias, or "" suffixes to unspecified StartDate value ignoring the suffix.

inherited

ConvertUniversalDateTimeStringToLocalDateTime(String? value) → DateTime?

Converts the universal date time String to local date time.

inherited

DefaultAutodiscoverRedirectionUrlValidationCallback(String redirectionUrl) → bool

Default implementation of AutodiscoverRedirectionUrlValidationCallback. Always returns true indicating that the URL can be used.

DoOnSerializeCustomSoapHeaders(XmlWriter? writer) → void

Calls the custom SOAP header serialization event handlers, if defined.

inherited

GetAutodiscoverServiceHosts(String domainName, OutParam<int> scpHostCountOutParam) → List<String>

Gets the list of autodiscover service hosts.

GetAutodiscoverServiceUrls(String domainName, OutParam<int> scpHostCountOutParam) → List<Uri?>

Defaults the get autodiscover service urls for domain.

GetLegacyUserSettings<TSettings extends ConfigurationSettingsBase>(TSettings newSettings, String emailAddress) → Future<TSettings>

Calls the legacy Autodiscover service to retrieve configuration settings.

GetSettings<TGetSettingsResponseCollection, TSettingName>(List<String> identities, List<TSettingName> settings, ExchangeVersion? requestedVersion, GetSettingsMethod<TGetSettingsResponseCollection, TSettingName> getSettingsMethod, GetDomainCallback getDomainMethod) → Future<TGetSettingsResponseCollection>

GetUserSettingsWithSmptAddresses(List<String> smtpAddresses, List<UserSettingName> settings) → Future<GetUserSettingsResponseCollection>

GetUserSettingsWithSmtpAddress(String userSmtpAddress, List<UserSettingName> userSettingNames) → Future<GetUserSettingsResponse>

Initializes a new instance of the

InternalGetLegacyUserSettings<TSettings extends ConfigurationSettingsBase>(TSettings newSettings, String emailAddress, List<String> redirectionEmailAddresses, OutParam<int> currentHopOutParam) → Future<TSettings>

Calls the legacy Autodiscover service to retrieve configuration settings.

InternalGetLegacyUserSettingsSimple(String emailAddress, List<UserSettingName> requestedSettings) → Future<GetUserSettingsResponse>

Gets user settings from Autodiscover legacy endpoint.

InternalGetSoapUserSettings(String smtpAddress, List<UserSettingName> requestedSettings) → Future<GetUserSettingsResponse>

Calls the SOAP Autodiscover service for user settings for a single SMTP address.

InternalProcessHttpErrorResponse(IEwsHttpWebResponse httpWebResponse, WebException webException, TraceFlags responseHeadersTraceFlag, TraceFlags responseTraceFlag) → void

Processes an HTTP error response

inherited

IsTraceEnabledFor(TraceFlags traceFlag) → bool

Determines whether tracing is enabled for specified trace flag(s).

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

PrepareHttpWebRequestForUrl(Uri url, bool acceptGzipEncoding, bool allowAutoRedirect) → Future<IEwsHttpWebRequest>

Creates an HttpWebRequest instance and initializes it with the appropriate parameters, based on the configuration of this service object.

inherited

ProcessHttpErrorResponse(IEwsHttpWebResponse httpWebResponse, WebException webException) → void

Processes an HTTP error response.

override

ProcessHttpResponseHeaders(TraceFlags traceType, IEwsHttpWebResponse response) → void

Traces the HTTP response headers.

inherited

SetContentType(IEwsHttpWebRequest request) → void

inherited

SetCustomUserAgent(String userAgent) → void

Register the custom auth module to support non-ascii upn authentication if the server supports that

inherited

toString() → String

A string representation of this object.

inherited

TraceHttpRequestHeaders(TraceFlags traceType, IEwsHttpWebRequest request) → void

Traces the HTTP request headers.

inherited

TraceMessage(TraceFlags traceType, String logEntry) → void

Logs the specified String to the TraceListener if tracing is enabled.

inherited

TraceResponse(IEwsHttpWebResponse response, MemoryStream memoryStream) → void

Traces the response.

TraceXml(TraceFlags traceType, MemoryStream stream) → void

Logs the specified XML to the TraceListener if tracing is enabled.

inherited

TryLastChanceHostRedirection<TSettings extends ConfigurationSettingsBase>(TSettings newSettings, String emailAddress, Uri redirectionUrl, OutParam<TSettings> settings) → Future<bool>

Get an autodiscover SRV record in DNS and construct autodiscover URL.

Validate() → void

Initializes a new instance of the

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

AutodiscoverMaxRedirections → const int

Maximum number of Url (or address) redirections that will be followed by an Autodiscover call