Class: Viewpoint::EWS::SearchFolder

Inherits:
GenericFolder show all
Defined in:
lib/model/search_folder.rb

Overview

This class represents a SearchFolderType object in the Exchange Data store.

Instance Attribute Summary

Attributes inherited from GenericFolder

#change_key, #folder_id, #parent_id, #subscription_id, #sync_state, #watermark

Attributes included from Model

#ews_methods, #ews_methods_undef

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from GenericFolder

#add_subfolder, #clear_sync_state!, #delete!, #find_items, folder_names, #get_events, get_folder, get_folder_by_name, get_folder_by_path, #get_item, #get_items, #items_between, #items_since, #search_by_subject, #subscribe, #subscribed?, #sync_items!, #sync_items_since!, #todays_items, #unsubscribe

Constructor Details

#initialize(folder) ⇒ SearchFolder

Returns a new instance of SearchFolder.



38
39
40
41
42
43
44
 
# File 'lib/model/search_folder.rb', line 38

def initialize(folder)
  super(folder)
  define_int_var :unread_count

  # @todo Handle:
  #   <SearchParameters/>
end

Class Method Details

.find_folders(root = :searchfolders, traversal = 'Deep', shape = 'Default', folder_type = nil) ⇒ Array

Find folders of type SearchFolder

Parameters:

  • root (String, Symbol) (defaults to: :searchfolders) —

    An folder id, either a DistinguishedFolderId (must me a Symbol) or a FolderId (String). SearchFolders must be created under the :searchfolders distinguished id so we might as well only search from there.

  • traversal (String) (defaults to: 'Deep') —

    Shallow/Deep/SoftDeleted

  • shape (String) (defaults to: 'Default') —

    the shape to return IdOnly/Default/AllProperties

  • folder_type (optional, String) (defaults to: nil) —

    an optional folder type to limit the search to like ‘IPF.Task’

Returns:

  • (Array) —

    Returns an Array of Folder or subclasses of Folder

See Also:



33
34
35
 
# File 'lib/model/search_folder.rb', line 33

def self.find_folders(root = :searchfolders, traversal = 'Deep', shape = 'Default', folder_type = nil)
  super(root, traversal, shape, folder_type)
end