Class EventsRequestBuilder
- Assembly
- Keycloak.AuthServices.Sdk.Kiota.dll
Builds and executes requests for operations under \admin\realms{realm}\events
public class EventsRequestBuilder : BaseRequestBuilder
- Inheritance
-
BaseRequestBuilderEventsRequestBuilder
- Inherited Members
-
BaseRequestBuilder.PathParametersBaseRequestBuilder.RequestAdapterBaseRequestBuilder.UrlTemplate
Constructors
EventsRequestBuilder(Dictionary<string, object>, IRequestAdapter)
Instantiates a new EventsRequestBuilder and sets the default values.
public EventsRequestBuilder(Dictionary<string, object> pathParameters, IRequestAdapter requestAdapter)
Parameters
pathParameters
Dictionary<string, object>Path parameters for the request
requestAdapter
IRequestAdapterThe request adapter to use to execute the requests.
EventsRequestBuilder(string, IRequestAdapter)
Instantiates a new EventsRequestBuilder and sets the default values.
public EventsRequestBuilder(string rawUrl, IRequestAdapter requestAdapter)
Parameters
rawUrl
stringThe raw URL to use for the request builder.
requestAdapter
IRequestAdapterThe request adapter to use to execute the requests.
Properties
Config
The config property
public ConfigRequestBuilder Config { get; }
Property Value
Methods
DeleteAsync(Action<RequestConfiguration<DefaultQueryParameters>>?, CancellationToken)
Delete all events
public Task DeleteAsync(Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)
Parameters
requestConfiguration
Action<RequestConfiguration<DefaultQueryParameters>>Configuration for the request such as headers, query parameters, and middleware options.
cancellationToken
CancellationTokenCancellation token to use when cancelling requests
Returns
GetAsync(Action<RequestConfiguration<EventsRequestBuilderGetQueryParameters>>?, CancellationToken)
Get events Returns all events, or filters them based on URL query parameters listed here
public Task<List<EventRepresentation>?> GetAsync(Action<RequestConfiguration<EventsRequestBuilder.EventsRequestBuilderGetQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)
Parameters
requestConfiguration
Action<RequestConfiguration<EventsRequestBuilder.EventsRequestBuilderGetQueryParameters>>Configuration for the request such as headers, query parameters, and middleware options.
cancellationToken
CancellationTokenCancellation token to use when cancelling requests
Returns
- Task<List<EventRepresentation>>
A List<EventRepresentation>
ToDeleteRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>?)
Delete all events
public RequestInformation ToDeleteRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null)
Parameters
requestConfiguration
Action<RequestConfiguration<DefaultQueryParameters>>Configuration for the request such as headers, query parameters, and middleware options.
Returns
- RequestInformation
A Microsoft.Kiota.Abstractions.RequestInformation
ToGetRequestInformation(Action<RequestConfiguration<EventsRequestBuilderGetQueryParameters>>?)
Get events Returns all events, or filters them based on URL query parameters listed here
public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<EventsRequestBuilder.EventsRequestBuilderGetQueryParameters>>? requestConfiguration = null)
Parameters
requestConfiguration
Action<RequestConfiguration<EventsRequestBuilder.EventsRequestBuilderGetQueryParameters>>Configuration for the request such as headers, query parameters, and middleware options.
Returns
- RequestInformation
A Microsoft.Kiota.Abstractions.RequestInformation
WithUrl(string)
Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.
public EventsRequestBuilder WithUrl(string rawUrl)
Parameters
rawUrl
stringThe raw URL to use for the request builder.