Skip to main content

IDataverseClient

  • Namespace: PPDS.Dataverse.Client
  • Assembly: PPDS.Dataverse
  • Kind: Interface
  • Implements: IOrganizationServiceAsync, IOrganizationServiceAsync2, IOrganizationService

Summary​

Abstraction over ServiceClient providing core Dataverse operations. Extends Microsoft.PowerPlatform.Dataverse.Client.IOrganizationServiceAsync2 with additional Dataverse-specific properties.

Members​

Methods​

Clone​

IDataverseClient Clone()

Creates a clone of this client that shares the underlying connection. Cloning is significantly faster than creating a new connection.

  • Returns: A cloned client instance.

GetRawWebApiAsync​

Task<string> GetRawWebApiAsync(string queryString, CancellationToken ct)

GETs a raw WebAPI query string and returns the response body as JSON. Used to traverse OData navigation properties not exposed as SDK attributes. Returns null on 404 or if the response is empty.

Properties​

CallerAADObjectId​

Nullable<Guid> CallerAADObjectId { get; set; }

Gets or sets the caller AAD object ID for impersonation.

CallerId​

Guid CallerId { get; set; }

Gets or sets the caller ID for impersonation.

ConnectedOrgFriendlyName​

string ConnectedOrgFriendlyName { get; }

Gets the connected organization friendly name.

ConnectedOrgId​

Nullable<Guid> ConnectedOrgId { get; }

Gets the connected organization ID.

ConnectedOrgUniqueName​

string ConnectedOrgUniqueName { get; }

Gets the connected organization unique name.

ConnectedOrgVersion​

Version ConnectedOrgVersion { get; }

Gets the connected organization version.

IsReady​

bool IsReady { get; }

Gets a value indicating whether the connection is ready for operations.

LastError​

string LastError { get; }

Gets the last error message from the service. Returns null when no error has occurred or the client is in a healthy state.

LastException​

Exception LastException { get; }

Gets the last exception from the service. Returns null when no exception has occurred or the client is in a healthy state.

MaxRetryCount​

int MaxRetryCount { get; set; }

Gets or sets the maximum number of retry attempts for transient failures.

RecommendedDegreesOfParallelism​

int RecommendedDegreesOfParallelism { get; }

Gets the server-recommended degree of parallelism for bulk operations.

RetryPauseTime​

TimeSpan RetryPauseTime { get; set; }

Gets or sets the pause time between retry attempts.