Skip to main content

DataverseClient

Struct DataverseClient 

Source
pub struct DataverseClient { /* private fields */ }
Expand description

HTTP client for the Dataverse OData Web API.

Provides methods for:

  • Initial change tracking requests (equivalent to RetrieveEntityChangesRequest without DataVersion)
  • Delta polling (equivalent to RetrieveEntityChangesRequest with DataVersion)
  • Standard data retrieval for bootstrap

Implementations§

Source§

impl DataverseClient

Source

pub fn new( environment_url: &str, api_version: &str, identity_provider: Arc<dyn IdentityProvider>, ) -> Self

Create a new Dataverse client.

§Arguments
  • environment_url - Dataverse environment URL (e.g., https://myorg.crm.dynamics.com)
  • api_version - Web API version (e.g., v9.2)
  • identity_provider - Identity provider for authentication
Source

pub async fn initial_change_tracking( &self, entity_set_name: &str, select: Option<&str>, ) -> Result<ODataDeltaResponse>

Perform an initial change tracking request for an entity.

This is the Web API equivalent of executing RetrieveEntityChangesRequest without a DataVersion – it returns all current records plus an initial delta token for subsequent change tracking.

Equivalent to the platform’s GetCurrentDeltaToken() method which pages through all initial data.

§Arguments
  • entity_set_name - The entity set name (plural, e.g., accounts)
  • select - Optional $select clause for column filtering

Follow a delta link to poll for changes.

This is the Web API equivalent of executing RetrieveEntityChangesRequest with DataVersion set to a previously obtained delta token.

Maps directly to the platform’s GetChanges(deltaToken) method.

§Arguments
  • delta_link - The delta link URL from a previous response

Follow a next link for pagination within a response.

Equivalent to following the platform’s PagingCookie for additional pages.

§Arguments
  • next_link - The next link URL from the current page
Source

pub async fn get_entity_data( &self, entity_set_name: &str, select: Option<&str>, ) -> Result<ODataDeltaResponse>

Retrieve all records from an entity (for bootstrap).

Sends a standard GET request without change tracking headers. Used by the bootstrap provider to load initial data.

§Arguments
  • entity_set_name - The entity set name (plural, e.g., accounts)
  • select - Optional $select clause for column filtering
Source

pub fn base_url(&self) -> &str

Get the base URL for this client.

Source

pub fn api_version(&self) -> &str

Get the API version.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more