VideoOS.Platform.Search Namespace Reference

Namespaces

namespace  Errors
 
namespace  FilterCategories
 
namespace  FilterConfigurations
 
namespace  FilterValues
 
namespace  Results
 
namespace  SearchFilters
 

Classes

class  ActivateResult
 Result of the SearchToolbarPluginInstance.Activate method. More...
 
class  ConcurrentDictionaryExtension
 Extension method for thread-safe removal of elements if both the user-provided key and value match the corresponding pair currently stored in the dictionary.
 
class  SearchAgentErrorEventArgs
 Event args attached to the SearchDefinition.ErrorOccurred-event.
 
class  SearchAgentPlugin
 Defines the search agent plugin interface. Inherit this class to create an implementation of a specific type of search agent. More...
 
class  SearchAgentResultReadyEventArgs
 Event arguments used when a partial search result is ready.
 
class  SearchCriteria
 Data class containing all search criteria data (i.e. values of selected SearchFilters) which is to be used in the SearchDefinition it belongs to. More...
 
class  SearchCriteriaChangedEventArgs
 Event args used when the SearchCriteria changes. More...
 
class  SearchDefinition
 Represents an independent search definition. More...
 
class  SearchDoneEventArgs
 Event arguments used when a Search.SearchDefinition has finished its search. More...
 
class  SearchErrorEventArgs
 Event args attached to the ISearchManager.ErrorOccurred-event. More...
 
class  SearchFilter
 Represents a single searchable filter. More...
 
class  SearchFilterCategory
 Represents a single searchable category containing all the filters associated with that category. More...
 
class  SearchFilterEditControl
 Represents a user control used to set the values for a given FilterValueBase. Implementations of this class are responsible for constructing the UI allowing the user to create/modify the value(s) of the associated FilterValueBase. More...
 
class  SearchInput
 Data class representing the input to the SearchDefinition.Search(VideoOS.Platform.Search.SearchInput,System.Threading.CancellationToken) method. More...
 
class  SearchManager
 A single-entry point for performing searches across the VMS system. The search manager will expose all available searches supplied by loaded search agent plugins. A search can be started across multiple search agents and run simultaneously by the search manager.
More...
 
class  SearchResultData
 Represents a single search result. A search performed on a Search.SearchDefinition instance may yield many instances of derivatives of this class. More...
 
class  SearchResultDataMetadataObjects
 Class representing a set of metadata objects that is associated with a SearchResultData. More...
 
class  SearchResultReadyEventArgs
 Event arguments used when a partial search result is ready from the SearchManager. More...
 
class  SearchResultUserControl
 User control used to visualize a given SearchResultData. More...
 
class  SearchScope
 Search scope used when starting a search. Includes a timespan and list of items in which to limit the search. More...
 
class  SearchToolbarPlugin
 The SearchToolbarPlugin defines a plugin that resides in the action/preview area of the Search tab in Smart Client. More...
 
class  SearchToolbarPluginInstance
 Instance of a SearchToolbarPlugin. An instance is needed for every place in the UI where the toolbar action is shown. More...
 
class  SearchUserControlResolver
 Singleton used to resolve/instantiate user controls for search results and/or search filters. More...
 
class  SearchUserControlsPlugin
 Defines the search user controls plugin interface. Inherit this class to create custom UI controls to visualize SearchResultData and/or FilterConfigurationBase instances. More...
 

Enumerations

enum  SearchCriteriaChangeType { FilterValueUpdated , FilterValueRemoved , FilterValueAdded , SearchScopeUpdated }
 Enumeration of the change types that can occur on a SearchCriteria. More...
 
enum  SearchSortOrder {
  Unspecified = 0 , NewestStartTime = 1 , OldestStartTime = 2 , NewestEventTime = 3 ,
  OldestEventTime = 4
}
 Sort order enumeration indicating the currently selected sort order in the client. More...
 

Enumeration Type Documentation

◆ SearchCriteriaChangeType

Enumeration of the change types that can occur on a SearchCriteria.

Enumerator
FilterValueUpdated 

Filter value updated.

FilterValueRemoved 

Filter value removed.

FilterValueAdded 

Filter value added.

SearchScopeUpdated 

The SearchScope was updated in the SearchCriteria.

◆ SearchSortOrder

Sort order enumeration indicating the currently selected sort order in the client.

Enumerator
Unspecified 

Sort order not specified by client.

NewestStartTime 

Sort by start time with the most recent start times first.

OldestStartTime 

Sort by start time with the oldest start times first.

NewestEventTime 

Sort by event time with the most recent event times first.

OldestEventTime 

Sort by event time with the oldest event times first.