Class OpenBiInquiryExtensions
Extension methods for inquiries.
Inheritance
OpenBiInquiryExtensions
Namespace: BiExcellence.OpenBi.Api.Commands.Inquiries
Assembly: BiExcellence.OpenBi.Api.Inquiry.dll
Syntax
public static class OpenBiInquiryExtensionsMethods
DeleteInquiriesAsync(IOpenBiSession, IEnumerable<IInquiry>, CancellationToken)
Deletes inquiries.
Declaration
public static Task DeleteInquiriesAsync(this IOpenBiSession session, IEnumerable<IInquiry> inquiries, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| IOpenBiSession | session | The session. |
| IEnumerable<IInquiry> | inquiries | The inquiries. |
| CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| Task |
DeleteInquiriesAsync(IOpenBiSession, IEnumerable<string>, CancellationToken)
Deletes inquiries by id.
Declaration
public static Task DeleteInquiriesAsync(this IOpenBiSession session, IEnumerable<string> ids, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| IOpenBiSession | session | The session. |
| IEnumerable<string> | ids | The inquiry ids. |
| CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| Task |
DeleteInquiryAsync(IOpenBiSession, IInquiry, CancellationToken)
Deletes an inquiry.
Declaration
public static Task DeleteInquiryAsync(this IOpenBiSession session, IInquiry inquiry, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| IOpenBiSession | session | The session. |
| IInquiry | inquiry | The inquiry. |
| CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| Task |
DeleteInquiryAsync(IOpenBiSession, string, CancellationToken)
Deletes an inquiry by id.
Declaration
public static Task DeleteInquiryAsync(this IOpenBiSession session, string inquiryId, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| IOpenBiSession | session | The session. |
| string | inquiryId | The inquiry id. |
| CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| Task |
GetInquiries(IOpenBiSession)
Returns inquiries.
Declaration
public static IListRequest<IInquiry> GetInquiries(this IOpenBiSession session)Parameters
| Type | Name | Description |
|---|---|---|
| IOpenBiSession | session | The session. |
Returns
| Type | Description |
|---|---|
| IListRequest<IInquiry> |
GetInquiriesByInquirerAsync(IOpenBiSession, string, CancellationToken)
Returns all inquiriers for an inquirer.
Declaration
public static Task<IList<IInquiry>> GetInquiriesByInquirerAsync(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<IList<IInquiry>> |
GetInquiryByIdAsync(IOpenBiSession, string, CancellationToken)
Returns an inquiry by its id.
Declaration
public static Task<IInquiry?> GetInquiryByIdAsync(this IOpenBiSession session, string id, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| IOpenBiSession | session | The session. |
| string | id | The inquiry id. |
| CancellationToken | cancellationToken | The cancellation token. |
Returns
| Type | Description |
|---|---|
| Task<IInquiry> |