Class OpenBiInquirerExtensions
Extension methods for inquirers.
Inheritance
OpenBiInquirerExtensions
Namespace: BiExcellence.OpenBi.Api.Commands.Inquiries
Assembly: BiExcellence.OpenBi.Api.Inquiry.dll
Syntax
public static class OpenBiInquirerExtensions
Methods
DeleteInquirerAsync(IOpenBiSession, IInquirer, CancellationToken)
Deletes an inquirer.
Declaration
public static Task DeleteInquirerAsync(this IOpenBiSession session, IInquirer inquirer, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| IOpenBiSession | session | The session. |
| IInquirer | inquirer | The inquirer. |
| CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| Task |
DeleteInquirerAsync(IOpenBiSession, string, CancellationToken)
Deletes an inquirer by id.
Declaration
public static Task DeleteInquirerAsync(this IOpenBiSession session, string inquirerId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| IOpenBiSession | session | The session. |
| string | inquirerId | The inquirer id. |
| CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| Task |
DeleteInquirersAsync(IOpenBiSession, IEnumerable<IInquirer>, CancellationToken)
Deletes inquirers.
Declaration
public static Task DeleteInquirersAsync(this IOpenBiSession session, IEnumerable<IInquirer> inquirers, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| IOpenBiSession | session | The session. |
| IEnumerable<IInquirer> | inquirers | The inquirers. |
| CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| Task |
DeleteInquirersAsync(IOpenBiSession, IEnumerable<string>, CancellationToken)
Deletes inquirers by id.
Declaration
public static Task DeleteInquirersAsync(this IOpenBiSession session, IEnumerable<string> ids, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| IOpenBiSession | session | The session. |
| IEnumerable<string> | ids | The inquirer ids. |
| CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| Task |
GetInquirerByIdAsync(IOpenBiSession, string, CancellationToken)
Returns an inquirer by its id.
Declaration
public static Task<IInquirer?> GetInquirerByIdAsync(this IOpenBiSession session, string id, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| IOpenBiSession | session | The session. |
| string | id | The inquirer id. |
| CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| Task<IInquirer> |
GetInquirers(IOpenBiSession)
Returns inquirers.
Declaration
public static IListRequest<IInquirer> GetInquirers(this IOpenBiSession session)
Parameters
| Type | Name | Description |
|---|---|---|
| IOpenBiSession | session | The session. |
Returns
| Type | Description |
|---|---|
| IListRequest<IInquirer> |