API Reference

Class

OfflineAddressBookSearchQuery

Namespace OfficeIMO.Email.AddressBook
Assembly OfficeIMO.Email
Modifiers sealed

Bounded, resumable query over decoded address-entry fields.

Inheritance

  • Object
  • OfflineAddressBookSearchQuery

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Constructors

public OfflineAddressBookSearchQuery(IEnumerable<String> terms, OfflineAddressBookSearchFields fields = All, OfflineAddressBookSearchMatchMode matchMode = AllTerms, String addressListId = null, Nullable<OfflineAddressBookObjectType> objectType = null, Int32 maxEntriesScanned = 100000, Int32 maxResults = 100, Int32 maxSearchableCharactersPerEntry = 1000000, Int32 snippetCharacters = 240, Int32 progressInterval = 1000, Boolean continueOnEntryError = true, OfflineAddressBookSearchCheckpoint resumeFrom = null) #

Creates a bounded query.

Parameters

terms System.Collections.Generic.IEnumerable{System.String} requiredposition: 0
fields OfficeIMO.Email.AddressBook.OfflineAddressBookSearchFields = All optionalposition: 1
matchMode OfficeIMO.Email.AddressBook.OfflineAddressBookSearchMatchMode = AllTerms optionalposition: 2
addressListId System.String = null optionalposition: 3
objectType System.Nullable{OfficeIMO.Email.AddressBook.OfflineAddressBookObjectType} = null optionalposition: 4
maxEntriesScanned System.Int32 = 100000 optionalposition: 5
maxResults System.Int32 = 100 optionalposition: 6
maxSearchableCharactersPerEntry System.Int32 = 1000000 optionalposition: 7
snippetCharacters System.Int32 = 240 optionalposition: 8
progressInterval System.Int32 = 1000 optionalposition: 9
continueOnEntryError System.Boolean = true optionalposition: 10
resumeFrom OfficeIMO.Email.AddressBook.OfflineAddressBookSearchCheckpoint = null optionalposition: 11

Properties

public IReadOnlyList<String> Terms { get; } #

Case-insensitive terms.

public OfflineAddressBookSearchFields Fields { get; } #

Fields searched.

public OfflineAddressBookSearchMatchMode MatchMode { get; } #

Term-combination mode.

public String AddressListId { get; } #

Optional address-list identifier.

public Nullable<OfflineAddressBookObjectType> ObjectType { get; } #

Optional projected object-type filter.

public Int32 MaxEntriesScanned { get; } #

Maximum records decoded in this batch.

public Int32 MaxResults { get; } #

Maximum matches returned in this batch.

public Int32 MaxSearchableCharactersPerEntry { get; } #

Maximum searchable characters retained across fields of one entry.

public Int32 SnippetCharacters { get; } #

Maximum snippet characters.

public Int32 ProgressInterval { get; } #

Scanned-entry interval between progress reports.

public Boolean ContinueOnEntryError { get; } #

Whether corrupt or over-limit records are diagnosed and skipped when their boundary is known.

public OfflineAddressBookSearchCheckpoint ResumeFrom { get; } #

Optional exact-position checkpoint from an earlier batch on the same session snapshot.