Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Folder

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

  • Initializes an unsaved local instance of . To bind to an existing folder, use Folder.Bind() instead.

    Parameters

    Returns Folder

Accessors

ArchiveTag

  • Gets or sets the archive tag.

    Returns ArchiveTag

  • Gets or sets the archive tag.

    Parameters

    Returns void

ChildFolderCount

  • get ChildFolderCount(): number

  • Gets the number of child folders this folder has.

    Returns number

DisplayName

  • get DisplayName(): string
  • set DisplayName(value: string): void

  • Gets or sets the display name of the folder.

    Returns string

  • Gets or sets the display name of the folder.

    Parameters

    • value: string

    Returns void

EffectiveRights

  • Gets a value indicating the effective rights the current authenticated user has on the folder.

    Returns EffectiveRights

ExtendedProperties

  • Gets a list of extended properties associated with the folder. Unstable Need testing

    Returns ExtendedPropertyCollection

FolderClass

  • get FolderClass(): string
  • set FolderClass(value: string): void

  • Gets or sets the custom class name of this folder.

    Returns string

  • Gets or sets the custom class name of this folder.

    Parameters

    • value: string

    Returns void

Id

  • Gets the Id of the folder.

    Returns FolderId

IsDirty

  • get IsDirty(): boolean

  • Gets a value indicating whether the object has been modified and should be saved.

    Returns boolean

IsNew

  • get IsNew(): boolean

  • Indicates whether this object is a real store item, or if it's a local object that has yet to be saved.

    Returns boolean

ManagedFolderInformation

  • Gets the Email Lifecycle Management (ELC) information associated with the folder.

    Returns ManagedFolderInformation

ParentFolderId

  • Gets the Id of this folder's parent folder.

    Returns FolderId

Permissions

  • Gets a list of permissions for the folder.

    Returns FolderPermissionCollection

PolicyTag

  • Gets or sets the policy tag.

    Returns PolicyTag

  • Gets or sets the policy tag.

    Parameters

    Returns void

PropertyBag

Schema

Service

TotalCount

  • get TotalCount(): number

  • Gets the total number of items contained in the folder.

    Returns number

UnreadCount

  • get UnreadCount(): number

  • Gets the number of unread items in the folder.

    Returns number

WellKnownFolderName

  • Gets the well known name of this folder, if any. value - The well known name of this folder, or null if this folder isn't a well known folder.

    Returns WellKnownFolderName

WellKnownFolderNameAsString

  • get WellKnownFolderNameAsString(): string

  • Gets the well known name of this folder, if any, as a string. value - The well known name of this folder as a string, or null if this folder isn't a well known folder.

    Returns string

_FolderType

  • get _FolderType(): string

  • _FolderTYpe -> type of folder, use to avoid folder type detection using instanceof. some cases it has circular loop in nodejs/requirejs

    Returns string

Methods

Changed

  • Changed(): void

  • Triggers dispatch of the change event.

    Returns void

ClearChangeLog

  • ClearChangeLog(): void

  • Clears the object's change log.

    Returns void

Copy

  • Copies this folder into the specified folder. Calling this method results in a call to EWS.

    Parameters

    • destinationFolderName: WellKnownFolderName

      The name of the folder in which to copy this folder.

    Returns IPromise<Folder>

    A Folder representing the copy of this folder :Promise.

  • Copies this folder into a specific folder. Calling this method results in a call to EWS.

    Parameters

    • destinationFolderId: FolderId

      The Id of the folder in which to copy this folder.

    Returns IPromise<Folder>

    A Folder representing the copy of this folder :Promise.

Delete

  • Deletes the folder. Calling this method results in a call to EWS.

    Parameters

    Returns IPromise<void>

Empty

  • Empties the folder. Calling this method results in a call to EWS.

    Parameters

    • deleteMode: DeleteMode

      The deletion mode.

    • deleteSubFolders: boolean

      Indicates whether sub-folders should also be deleted.

    Returns IPromise<void>

FindFolders

  • Obtains a list of folders by searching the sub-folders of this folder. Calling this method results in a call to EWS.

    Parameters

    • view: FolderView

      The view controlling the number of folders returned.

    Returns IPromise<FindFoldersResults>

    An object representing the results of the search operation :Promise.

  • Obtains a list of folders by searching the sub-folders of this folder. Calling this method results in a call to EWS.

    Parameters

    • searchFilter: SearchFilter

      The search filter. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection

    • view: FolderView

      The view controlling the number of folders returned.

    Returns IPromise<FindFoldersResults>

    An object representing the results of the search operation :Promise.

FindItems

  • Obtains a list of items by searching the contents of this folder. Calling this method results in a call to EWS.

    Parameters

    • view: ItemView

      The view controlling the number of items returned.

    Returns IPromise<FindItemsResults<Item>>

    An object representing the results of the search operation :Promise.

  • Obtains a grouped list of items by searching the contents of this folder. Calling this method results in a call to EWS.

    Parameters

    • view: ItemView

      The view controlling the number of items returned.

    • groupBy: Grouping

      The grouping criteria.

    Returns IPromise<GroupedFindItemsResults<Item>>

    A collection of grouped items representing the contents of this folder :Promise.

  • Obtains a list of items by searching the contents of this folder. Calling this method results in a call to EWS.

    Parameters

    • queryString: string

      query string to be used for indexed search

    • view: ItemView

      The view controlling the number of items returned.

    Returns IPromise<FindItemsResults<Item>>

    An object representing the results of the search operation :Promise.

  • Obtains a list of items by searching the contents of this folder. Calling this method results in a call to EWS.

    Parameters

    • searchFilter: SearchFilter

      The search filter. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection

    • view: ItemView

      The view controlling the number of items returned.

    Returns IPromise<FindItemsResults<Item>>

    An object representing the results of the search operation :Promise.

  • Obtains a grouped list of items by searching the contents of this folder. Calling this method results in a call to EWS.

    Parameters

    • queryString: string

      Query string to be used for indexed search

    • view: ItemView

      The view controlling the number of items returned.

    • groupBy: Grouping

      The grouping criteria.

    Returns IPromise<GroupedFindItemsResults<Item>>

    A collection of grouped items representing the contents of this folder :Promise.

  • Obtains a grouped list of items by searching the contents of this folder. Calling this method results in a call to EWS.

    Parameters

    • searchFilter: SearchFilter

      The search filter. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection

    • view: ItemView

      The view controlling the number of items returned.

    • groupBy: Grouping

      The grouping criteria.

    Returns IPromise<GroupedFindItemsResults<Item>>

    A collection of grouped items representing the contents of this folder :Promise.

GetChangeXmlElementName

  • GetChangeXmlElementName(): string
  • internal

    Gets the name of the change XML element.

    Returns string

    XML element name,

GetDeleteFieldXmlElementName

  • GetDeleteFieldXmlElementName(): string

GetExtendedProperties

GetId

  • The unique Id of this object.

    Returns ServiceId

    A ServiceId instance..

GetIdPropertyDefinition

GetIsCustomDateTimeScopingRequired

  • GetIsCustomDateTimeScopingRequired(): boolean

  • Determines whether properties defined with ScopedDateTimePropertyDefinition require custom time zone scoping.

    Returns boolean

    true if this item type requires custom scoping for scoped date/time properties; otherwise, false.

GetIsTimeZoneHeaderRequired

  • GetIsTimeZoneHeaderRequired(isUpdateOperation: boolean): boolean

  • Gets a value indicating whether a time zone SOAP header should be emitted in a CreateItem or UpdateItem request so this item can be property saved or updated.

    Parameters

    • isUpdateOperation: boolean

      Indicates whether the operation being petrformed is an update operation.

    Returns boolean

    true if a time zone SOAP header should be emitted; otherwise, false.

GetLoadedPropertyDefinitions

GetMinimumRequiredServerVersion

GetSchema

  • internal

    Internal method to return the schema associated with this type of object.

    Returns ServiceObjectSchema

    The schema associated with this type of object.

GetSetFieldXmlElementName

  • GetSetFieldXmlElementName(): string
  • internal

    Gets the name of the set field XML element.

    Returns string

    XML element name,

GetXmlElementName

  • GetXmlElementName(): string
  • internal

    Gets the element name of item in XML

    Returns string

    name of elelment

GetXmlElementNameOverride

  • GetXmlElementNameOverride(): string

  • This methods lets subclasses of ServiceObject override the default mechanism by which the XML element name associated with their type is retrieved.

    Returns string

    The XML element name associated with this type. If this method returns null or empty, the XML element name associated with this type is determined by the EwsObjectDefinition attribute that decorates the type, if present.

InternalDelete

InternalFindItems

  • internal

    Find items.

    Type parameters

    Parameters

    • queryString: string

      Query string to be used for indexed search

    • view: ViewBase

      The view controlling the number of items returned.

    • groupBy: Grouping

      The group by.

    Returns IPromise<ServiceResponseCollection<FindItemResponse<TItem>>>

    FindItems response collection :Promise.

  • internal

    Find items.

    Type parameters

    Parameters

    • searchFilter: SearchFilter

      The search filter. Available search filter classes include SearchFilter.IsEqualTo, SearchFilter.ContainsSubstring and SearchFilter.SearchFilterCollection

    • view: ViewBase

      The view controlling the number of items returned.

    • groupBy: Grouping

      The group by.

    Returns IPromise<ServiceResponseCollection<FindItemResponse<TItem>>>

    FindItems response collection :Promise.

  • shim used internally to minimize code flow logic from calling functions

    Type parameters

    Parameters

    Returns IPromise<ServiceResponseCollection<FindItemResponse<TItem>>>

InternalLoad

  • internal

    Loads the specified set of properties on the object.

    Parameters

    Returns IPromise<void>

Load

  • Loads the first class properties. Calling this method results in a call to EWS.

    Returns IPromise<void>

  • Loads the specified set of properties. Calling this method results in a call to EWS.

    Parameters

    • Optional propertySet: PropertySet

      The properties to load.

    Returns IPromise<void>

LoadFromXmlJsObject

  • LoadFromXmlJsObject(jsObject: any, service: ExchangeService, clearPropertyBag: boolean, requestedPropertySet?: PropertySet, summaryPropertiesOnly?: boolean): void

  • Loads service object from XML.

    Parameters

    • jsObject: any

      Jason Object converted from XML.

    • service: ExchangeService

      The service.

    • clearPropertyBag: boolean

      if set to true [clear property bag].

    • Default value requestedPropertySet: PropertySet = null

      The property set.

    • Default value summaryPropertiesOnly: boolean = false

      if set to true [summary props only].

    Returns void

MarkAllItemsAsRead

  • MarkAllItemsAsRead(suppressReadReceipts: boolean): IPromise<void>

  • Marks all items in folder as read. Calling this method results in a call to EWS.

    Parameters

    • suppressReadReceipts: boolean

      If true, suppress sending read receipts for items.

    Returns IPromise<void>

MarkAllItemsAsUnread

  • MarkAllItemsAsUnread(suppressReadReceipts: boolean): IPromise<void>

  • Marks all items in folder as read. Calling this method results in a call to EWS.

    Parameters

    • suppressReadReceipts: boolean

      If true, suppress sending read receipts for items.

    Returns IPromise<void>

Move

  • Moves this folder to the specified folder. Calling this method results in a call to EWS.

    Parameters

    • destinationFolderName: WellKnownFolderName

      The name of the folder in which to move this folder.

    Returns IPromise<Folder>

    A new folder representing this folder in its new location. After Move completes, this folder does not exist anymore :Promise.

  • Moves this folder to a specific folder. Calling this method results in a call to EWS.

    Parameters

    • destinationFolderId: FolderId

      The Id of the folder in which to move this folder.

    Returns IPromise<Folder>

    A new folder representing this folder in its new location. After Move completes, this folder does not exist anymore :Promise.

RemoveExtendedProperty

  • Removes an extended property.

    Parameters

    Returns boolean

    True if property was removed.

Save

  • Saves this folder in a specific folder. Calling this method results in a call to EWS.

    Parameters

    Returns IPromise<void>

  • Saves this folder in a specific folder. Calling this method results in a call to EWS.

    Parameters

    • parentFolderId: FolderId

      The Id of the folder in which to save this folder.

    Returns IPromise<void>

SetExtendedProperty

  • Sets the extended property.

    Parameters

    Returns void

ThrowIfThisIsNew

  • ThrowIfThisIsNew(): void

  • Throws exception if this is a new service object.

    Returns void

ThrowIfThisIsNotNew

  • ThrowIfThisIsNotNew(): void

  • Throws exception if this is not a new service object.

    Returns void

TryGetExtendedProperty

  • Try to get the value of a specified extended property in this instance.

    Type parameters

    • T

    Parameters

    Returns boolean

    True if property retrieved, false otherwise.

TryGetProperty

  • Try to get the value of a specified property in this instance.

    Type parameters

    • T

    Parameters

    Returns boolean

    True if property retrieved, false otherwise.

Update

  • Applies the local changes that have been made to this folder. Calling this method results in a call to EWS.

    Returns IPromise<void>

Validate

  • Validate(): void
  • internal

    Validates this instance.

    Returns void

WriteToXml

WriteToXmlForUpdate

_getItem

  • Gets the value of specified property in this instance. This Indexer of c#

    Parameters

    Returns any

Static Bind

  • Binds to an existing folder, whatever its actual type is, and loads the specified set of properties. Calling this method results in a call to EWS.

    Parameters

    Returns IPromise<Folder>

    A Folder instance representing the folder corresponding to the specified Id :Promise.

  • Binds to an existing folder, whatever its actual type is, and loads the specified set of properties. Calling this method results in a call to EWS.

    Parameters

    Returns IPromise<Folder>

    A Folder instance representing the folder corresponding to the specified name :Promise.

  • Binds to an existing folder, whatever its actual type is, and loads the specified set of properties. Calling this method results in a call to EWS.

    Parameters

    • service: ExchangeService

      The service to use to bind to the folder.

    • id: FolderId

      The Id of the folder to bind to.

    • propertySet: PropertySet

      The set of properties to load.

    Returns IPromise<Folder>

    A Folder instance representing the folder corresponding to the specified Id :Promise.

  • Binds to an existing folder, whatever its actual type is, and loads the specified set of properties. Calling this method results in a call to EWS.

    Parameters

    Returns IPromise<Folder>

    A Folder instance representing the folder corresponding to the specified name :Promise.

Generated using TypeDoc