 | Canary |
Base class for server-side implementations of CanaryViewsApiService
Inheritance HierarchyNamespace: Canary.Views.Grpc.Api
Assembly: Canary.Views.Grpc.Api (in Canary.Views.Grpc.Api.dll) Version: 25.6.0.25344+3070493948bf7d32a86bd3e9a8bcf4cc9a5b1929
SyntaxC#
public abstract class CanaryViewsApiServiceBase
The CanaryViewsApiServiceCanaryViewsApiServiceBase type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CanaryViewsApiServiceCanaryViewsApiServiceBase | Initializes a new instance of the CanaryViewsApiServiceCanaryViewsApiServiceBase class |
Methods| Name | Description | |
|---|---|---|
 | AxiomInternal | / exclude-from-docs Connect to Axiom and handle requests from Axiom. |
| Browse | / Browse Views using the node ID for a node |
| BrowseAutoComplete | / Browse views for nodes that match the conditions passed in |
| BrowsePath | / Browse tags based off a specific path. |
| BrowseTags | / Browse the tags of a specified node. |
| FindEvents | / Get all the events from the Calculations service that meet the specified search criteria. |
| GetAggregateData | / Get the aggregated data of a selected tag. |
| GetAggregateList | / Get a list of the aggregates. |
| GetAnnotations | / Get the annotations for the selected tags. |
| GetBatchEventAssetContext | / Get the asset context for the given batch event types |
| GetBatchEventMetadataFilterKeys | / Get the superset of metadata filter keys against the batch event types that match the given filter criteria. |
| GetBatchEventMetadataFilterValueSet | / Get a superset of the metadata value sets against the given event types for a metadata key. |
| GetBatchEvents | / Get batch events that match the given filter criteria. |
| GetBatchEventTypes | / Get the types of batch events. |
| GetClientConnectionId | / Create a new client connection ID. |
| GetDatasetInfo | / Gets information about a specific Dataset. |
| GetDataSetList | / Get a list of the Datasets for a specific view. |
| GetEventCalculationNames | / Get the names of the events from the Calculations service. |
| GetEventPropertyNames | / Get the names of the event properties from the Calculations service. |
| GetHostName | / Get the name of the host machine. |
| GetIdentityEndpoints | / Get the endpoints used to communicate with the Identity service. |
| GetModelInstances | / Get all model instances. |
| GetModelTypes | / Get the types of a Model. |
| GetModelTypeTags | / Get the type tags for the model. |
| GetModelViews | / Get the Model views. |
| GetRawData | / Get the raw data of selected tags for the specified time frame. |
| GetReadableQuality | / Get the readable version of the selected quality. |
| GetTagCurrentValue | / Get the current value of the selected tags. |
| GetTagDataContext | / Get the context for the selected tags. |
| GetTagInfo | / Get information for the specified tags. |
| GetTagList | / Get a list of the tags for a specified dataset. |
| GetTagStatistics | / Get the statistics of a specified tag. |
| GetViewInfo | / Get the information of all views. |
| GetViewInfoSingle | / Get information of a specific view. |
| GetViews | / Get a list of the views. |
| GetWebServiceInterfaceVersion | / Get the current version of the interface. |
| GetWebServiceVersion | / Get the current version of the service. |
| KeepaliveClientConnectionId | / Keep alive the specified client connection ID. |
| ParseInterval | / Parse the interval string into a duration object. |
| ParseTimestamp | / Parse a string version of a timestamp into a timestamp object. |
| ReleaseClientConnectionId | / Release the client connection ID. This does not affect the views connection. |
| SearchForEvents | / Search for any events within a specified window with the specified event information. |
| SearchTags | / Search for any tags that meet the specific criteria. |
| SetVirtualTimeExtensionFlag | / Set the Virtual Time Extension Flag for returning time extended values. |
| StoreAnnotation | / Save an annotation to a tag. |
| SubscribeToLiveData | / Subscribe to tags in order to get the latest data. |
| Test | / Test the gRPC connection. |
See Also