Interface IProviderProfileClient

Namespace

OpenShell

Assembly

OpenShell.Sdk.dll

Provider type profile operations.

public interface IProviderProfileClient

Properties

Platform

A view of this client that targets platform (global) profiles instead of one workspace.

IProviderProfileClient Platform { get; }

Property Value

IProviderProfileClient

Methods

DeleteAsync(string, DeleteOptions?, CancellationToken)

Deletes a custom profile.

ValueTask<DeletionResult> DeleteAsync(string id, DeleteOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

options DeleteOptions

cancellationToken CancellationToken

Returns

ValueTask<DeletionResult>

GetAsync(string, CancellationToken)

Gets a profile by id.

ValueTask<ProviderProfile> GetAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

cancellationToken CancellationToken

Returns

ValueTask<ProviderProfile>

ImportAsync(IReadOnlyList<ProfileImportItem>, ProfileMutationOptions?, CancellationToken)

Imports custom profiles. Check Imported and diagnostics.

ValueTask<ImportProfilesResult> ImportAsync(IReadOnlyList<ProfileImportItem> items, ProfileMutationOptions? options = null, CancellationToken cancellationToken = default)

Parameters

items IReadOnlyList<ProfileImportItem>

options ProfileMutationOptions

cancellationToken CancellationToken

Returns

ValueTask<ImportProfilesResult>

LintAsync(IReadOnlyList<ProfileImportItem>, CancellationToken)

Validates profiles without storing them.

ValueTask<LintProfilesResult> LintAsync(IReadOnlyList<ProfileImportItem> items, CancellationToken cancellationToken = default)

Parameters

items IReadOnlyList<ProfileImportItem>

cancellationToken CancellationToken

Returns

ValueTask<LintProfilesResult>

List(ListOptions?)

Lists profiles lazily.

Pager<ProviderProfile> List(ListOptions? options = null)

Parameters

options ListOptions

Returns

Pager<ProviderProfile>

UpdateAsync(string, ulong, ProfileImportItem, ProfileMutationOptions?, CancellationToken)

Updates one custom profile with optimistic concurrency.

ValueTask<UpdateProfileResult> UpdateAsync(string id, ulong expectedResourceVersion, ProfileImportItem item, ProfileMutationOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

expectedResourceVersion ulong

item ProfileImportItem

options ProfileMutationOptions

cancellationToken CancellationToken

Returns

ValueTask<UpdateProfileResult>