St2.Client.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>St2.Client</name> </assembly> <members> <member name="T:TonyBaloney.St2.Client.Apis.ActionsApi"> <summary> The actions api. </summary> </member> <member name="T:TonyBaloney.St2.Client.Apis.IActionsApi"> <summary> Interface for actions API. </summary> </member> <member name="M:TonyBaloney.St2.Client.Apis.IActionsApi.GetActionsAsync"> <summary> Get all available Actions. </summary> <returns> A List of <see cref="T:TonyBaloney.St2.Client.Models.Action"/>. </returns> </member> <member name="M:TonyBaloney.St2.Client.Apis.IActionsApi.GetActionsForPackAsync(System.String)"> <summary> Gets actions for pack. </summary> <param name="pack"> The pack name. </param> <returns> A List of <see cref="T:TonyBaloney.St2.Client.Models.Action"/>. </returns> </member> <member name="M:TonyBaloney.St2.Client.Apis.IActionsApi.GetActionsByNameAsync(System.String)"> <summary> Gets actions by name. </summary> <param name="name"> The action name. </param> <returns> A List of <see cref="T:TonyBaloney.St2.Client.Models.Action"/>. </returns> </member> <member name="M:TonyBaloney.St2.Client.Apis.IActionsApi.DeleteActionAsync(System.String)"> <summary> Deletes the action described by actionId. </summary> <param name="actionId"> can be either the ID (e.g. 1 or the ref e.g. mypack.myaction). </param> </member> <member name="M:TonyBaloney.St2.Client.Apis.IActionsApi.CreateActionAsync(TonyBaloney.St2.Client.Models.CreateAction)"> <summary> Creates a new action. </summary> <param name="action"> The <see cref="T:TonyBaloney.St2.Client.Models.Action"/> to create. </param> </member> <member name="M:TonyBaloney.St2.Client.Apis.ActionsApi.#ctor(TonyBaloney.St2.Client.ISt2Client)"> <summary> Initializes a new instance of the TonyBaloney.St2.Client.Apis.ActionsApi class. </summary> <exception cref="T:System.ArgumentNullException">Thrown when one or more required arguments are null. </exception> <param name="host"> The host. </param> </member> <member name="M:TonyBaloney.St2.Client.Apis.ActionsApi.GetActionsAsync"> <summary> Get all available Actions. </summary> <returns> A List of Actions<see cref="T:TonyBaloney.St2.Client.Models.Action"/>. </returns> <seealso cref="M:TonyBaloney.St2.Client.Apis.IActionsApi.GetActionsAsync()"/> </member> <member name="M:TonyBaloney.St2.Client.Apis.ActionsApi.GetActionsForPackAsync(System.String)"> <summary> Gets actions for pack. </summary> <param name="pack"> The pack name. </param> <returns> A List of Actions<see cref="T:TonyBaloney.St2.Client.Models.Action"/>. </returns> <seealso cref="M:TonyBaloney.St2.Client.Apis.IActionsApi.GetActionsForPackAsync(string)"/> </member> <member name="M:TonyBaloney.St2.Client.Apis.ActionsApi.GetActionsByNameAsync(System.String)"> <summary> Gets actions by name. </summary> <param name="name"> The action name. </param> <returns> A List of Actions<see cref="T:TonyBaloney.St2.Client.Models.Action"/>. </returns> <seealso cref="M:TonyBaloney.St2.Client.Apis.IActionsApi.GetActionsByNameAsync(string)"/> </member> <member name="M:TonyBaloney.St2.Client.Apis.ActionsApi.DeleteActionAsync(System.String)"> <summary> Deletes the action described by actionId. </summary> <param name="actionId">can be either the ID (e.g. 1 or the ref e.g. mypack.myaction). </param> <seealso cref="M:TonyBaloney.St2.Client.Apis.IActionsApi.DeleteActionAsync(string)"/> </member> <member name="M:TonyBaloney.St2.Client.Apis.ActionsApi.CreateActionAsync(TonyBaloney.St2.Client.Models.CreateAction)"> <summary> Creates a new action. </summary> <param name="action"> The <see cref="T:TonyBaloney.St2.Client.Models.Action"/> to create. </param> <returns> The new action asynchronous. </returns> <seealso cref="M:TonyBaloney.St2.Client.Apis.IActionsApi.CreateActionAsync(Action)"/> </member> <member name="T:TonyBaloney.St2.Client.Apis.ExecutionsApi"> <summary> The executions API. </summary> <seealso cref="T:TonyBaloney.St2.Client.Apis.IExecutionsApi"/> </member> <member name="T:TonyBaloney.St2.Client.Apis.IExecutionsApi"> <summary> Interface for executions API. </summary> </member> <member name="M:TonyBaloney.St2.Client.Apis.IExecutionsApi.GetExecutionAsync(System.String)"> <summary> Gets execution. </summary> <param name="id"> The identifier. </param> <returns> The execution. </returns> </member> <member name="M:TonyBaloney.St2.Client.Apis.IExecutionsApi.GetExecutionsAsync(System.Int32)"> <summary> Gets a list of executions. </summary> <param name="limit"> The number of items to return (default 5). </param> <returns> A list of <see cref="T:TonyBaloney.St2.Client.Models.Execution"/>. </returns> </member> <member name="M:TonyBaloney.St2.Client.Apis.IExecutionsApi.GetExecutionsForActionAsync(System.String,System.Int32)"> <summary> Gets executions for action. </summary> <param name="actionName"> Name of the action. </param> <param name="limit"> The number of items to return (default 5). </param> <returns> A list of <see cref="T:TonyBaloney.St2.Client.Models.Execution"/>. </returns> </member> <member name="M:TonyBaloney.St2.Client.Apis.IExecutionsApi.ExecuteActionAsync(System.String,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Executes the action. </summary> <param name="actionName"> Name of the action. </param> <param name="parameters"> The parameters for the given action. </param> <returns> The resulting execution; </returns> </member> <member name="M:TonyBaloney.St2.Client.Apis.IExecutionsApi.ExecuteActionAsync(System.String,System.Collections.Generic.Dictionary{System.String,System.Object})"> <summary> Executes the action. </summary> <param name="actionName"> Name of the action. </param> <param name="parameters"> The parameters for the given action. </param> <returns> The resulting execution; </returns> </member> <member name="M:TonyBaloney.St2.Client.Apis.ExecutionsApi.#ctor(TonyBaloney.St2.Client.ISt2Client)"> <summary> Initializes a new instance of the TonyBaloney.St2.Client.Apis.ExecutionsApi class. </summary> <exception cref="T:System.ArgumentNullException">Thrown when one or more required arguments are null. </exception> <param name="host"> The host. </param> </member> <member name="M:TonyBaloney.St2.Client.Apis.ExecutionsApi.GetExecutionAsync(System.String)"> <summary> Gets execution. </summary> <param name="id"> The identifier. </param> <returns> The execution. </returns> <seealso cref="M:TonyBaloney.St2.Client.Apis.IExecutionsApi.GetExecutionAsync(string)"/> </member> <member name="M:TonyBaloney.St2.Client.Apis.ExecutionsApi.GetExecutionsAsync(System.Int32)"> <summary> Gets a list of executions. </summary> <param name="limit"> The number of items to return (default 5). </param> <returns> A list of <see cref="T:TonyBaloney.St2.Client.Models.Execution"/>. </returns> <seealso cref="M:TonyBaloney.St2.Client.Apis.IExecutionsApi.GetExecutionsAsync(int)"/> </member> <member name="M:TonyBaloney.St2.Client.Apis.ExecutionsApi.GetExecutionsForActionAsync(System.String,System.Int32)"> <summary> Gets executions for action. </summary> <param name="actionName"> Name of the action. </param> <param name="limit"> The number of items to return (default 5). </param> <returns> A list of <see cref="T:TonyBaloney.St2.Client.Models.Execution"/>. </returns> <seealso cref="M:TonyBaloney.St2.Client.Apis.IExecutionsApi.GetExecutionsForActionAsync(string,int)"/> </member> <member name="M:TonyBaloney.St2.Client.Apis.ExecutionsApi.ExecuteActionAsync(System.String,System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Executes the action. </summary> <param name="actionName"> Name of the action. </param> <param name="parameters"> The parameters for the given action. </param> <returns> The resulting execution; </returns> <seealso cref="M:TonyBaloney.St2.Client.Apis.IExecutionsApi.ExecuteActionAsync(string,Dictionary{string,string})"/> </member> <member name="M:TonyBaloney.St2.Client.Apis.ExecutionsApi.ExecuteActionAsync(System.String,System.Collections.Generic.Dictionary{System.String,System.Object})"> <summary> Executes the action. </summary> <param name="actionName"> Name of the action. </param> <param name="parameters"> The parameters for the given action. </param> <returns> The resulting execution; </returns> <seealso cref="M:TonyBaloney.St2.Client.Apis.IExecutionsApi.ExecuteActionAsync(string,Dictionary{string,object})"/> </member> <member name="T:TonyBaloney.St2.Client.Apis.IPacksApi"> <summary> Interface for packs API. </summary> </member> <member name="M:TonyBaloney.St2.Client.Apis.IPacksApi.GetPacksAsync"> <summary> Get a list of packs. </summary> <returns> A List of <see cref="T:TonyBaloney.St2.Client.Models.Pack"/>. </returns> </member> <member name="M:TonyBaloney.St2.Client.Apis.IPacksApi.GetPacksByNameAsync(System.String)"> <summary> Gets packs by name. </summary> <param name="packName"> Name of the pack. </param> <returns> A List of <see cref="T:TonyBaloney.St2.Client.Models.Pack"/>. </returns> </member> <member name="M:TonyBaloney.St2.Client.Apis.IPacksApi.GetPacksByIdAsync(System.String)"> <summary> Gets packs by identifier. </summary> <param name="packId"> Identifier for the pack. </param> <returns> A List of <see cref="T:TonyBaloney.St2.Client.Models.Pack"/>. </returns> </member> <member name="T:TonyBaloney.St2.Client.Apis.IRulesApi"> <summary> Interface for rules API. </summary> </member> <member name="M:TonyBaloney.St2.Client.Apis.IRulesApi.GetRulesAsync"> <summary> Gets rules. </summary> <returns> The rules. </returns> </member> <member name="M:TonyBaloney.St2.Client.Apis.IRulesApi.GetRulesForPackAsync(System.String)"> <summary> Gets rules for pack. </summary> <param name="packName"> Name of the pack. </param> <returns> The rules for pack. </returns> </member> <member name="M:TonyBaloney.St2.Client.Apis.IRulesApi.GetRulesByNameAsync(System.String)"> <summary> Gets rules by name. </summary> <param name="name"> The name. </param> <returns> The rules by name. </returns> </member> <member name="M:TonyBaloney.St2.Client.Apis.IRulesApi.DeleteRuleAsync(System.String)"> <summary> Deletes the rule described by ruleId. </summary> <param name="ruleId"> Identifier for the rule. </param> <returns> A Task. </returns> </member> <member name="T:TonyBaloney.St2.Client.Apis.PacksApi"> <summary> The packs api. </summary> <seealso cref="T:TonyBaloney.St2.Client.Apis.IPacksApi"/> </member> <member name="M:TonyBaloney.St2.Client.Apis.PacksApi.#ctor(TonyBaloney.St2.Client.ISt2Client)"> <summary> Initializes a new instance of the TonyBaloney.St2.Client.Apis.PacksApi class. </summary> <exception cref="T:System.ArgumentNullException">Thrown when one or more required arguments are null. </exception> <param name="host"> The host. </param> </member> <member name="M:TonyBaloney.St2.Client.Apis.PacksApi.GetPacksAsync"> <summary> Get a list of packs. </summary> <returns> A List of <see cref="T:TonyBaloney.St2.Client.Models.Pack"/>. </returns> <seealso cref="M:TonyBaloney.St2.Client.Apis.IPacksApi.GetPacksAsync()"/> </member> <member name="M:TonyBaloney.St2.Client.Apis.PacksApi.GetPacksByNameAsync(System.String)"> <summary> Gets packs by name. </summary> <param name="packName"> Name of the pack. </param> <returns> A List of <see cref="T:TonyBaloney.St2.Client.Models.Pack"/>. </returns> <seealso cref="M:TonyBaloney.St2.Client.Apis.IPacksApi.GetPacksByNameAsync(string)"/> </member> <member name="M:TonyBaloney.St2.Client.Apis.PacksApi.GetPacksByIdAsync(System.String)"> <summary> Gets packs by identifier. </summary> <param name="packId"> Identifier for the pack. </param> <returns> A List of <see cref="T:TonyBaloney.St2.Client.Models.Pack"/>. </returns> <seealso cref="M:TonyBaloney.St2.Client.Apis.IPacksApi.GetPacksByIdAsync(string)"/> </member> <member name="T:TonyBaloney.St2.Client.Apis.RulesApi"> <summary> The rules api. </summary> <seealso cref="T:TonyBaloney.St2.Client.Apis.IRulesApi"/> </member> <member name="F:TonyBaloney.St2.Client.Apis.RulesApi._host"> <summary> The host process. </summary> </member> <member name="M:TonyBaloney.St2.Client.Apis.RulesApi.#ctor(TonyBaloney.St2.Client.ISt2Client)"> <summary> Initializes a new instance of the TonyBaloney.St2.Client.Apis.RulesApi class. </summary> <exception cref="T:System.ArgumentNullException">Thrown when one or more required arguments are null. </exception> <param name="host"> The host. </param> </member> <member name="M:TonyBaloney.St2.Client.Apis.RulesApi.GetRulesAsync"> <summary> Gets rules . </summary> <returns> The rules . </returns> </member> <member name="M:TonyBaloney.St2.Client.Apis.RulesApi.GetRulesForPackAsync(System.String)"> <summary> Gets rules for pack . </summary> <param name="packName"> Name of the pack. </param> <returns> The rules for pack . </returns> </member> <member name="M:TonyBaloney.St2.Client.Apis.RulesApi.GetRulesByNameAsync(System.String)"> <summary> Gets rules by name . </summary> <param name="name"> The rule name. </param> <returns> The rules by name . </returns> </member> <member name="M:TonyBaloney.St2.Client.Apis.RulesApi.DeleteRuleAsync(System.String)"> <summary> Deletes the rule described by ruleId. </summary> <param name="ruleId"> Identifier for the rule. </param> <returns> A Task. </returns> <seealso cref="M:TonyBaloney.St2.Client.Apis.IRulesApi.DeleteRule(string)"/> </member> <member name="T:TonyBaloney.St2.Client.Exceptions.FailedRequestException"> <summary> Exception for signalling failed request errors. </summary> <seealso cref="T:System.Exception"/> </member> <member name="M:TonyBaloney.St2.Client.Exceptions.FailedRequestException.#ctor(System.String)"> <summary> Initializes a new instance of the TonyBaloney.St2.Client.Exceptions.FailedRequestException class. </summary> <param name="message"> The message. </param> </member> <member name="M:TonyBaloney.St2.Client.Exceptions.FailedRequestException.#ctor(System.String,System.Uri,System.Net.HttpStatusCode,System.String)"> <summary> Initializes a new instance of the FailedRequestException class. </summary> <param name="failureMessage"> Message describing the failure. </param> <param name="requestUri"> URI of the request. </param> <param name="statusCode"> The status code. </param> <param name="responseMessage"> Message describing the response. </param> </member> <member name="T:TonyBaloney.St2.Client.Exceptions.InvalidTokenException"> <summary> Exception for signalling invalid token errors. </summary> <seealso cref="T:System.Exception"/> </member> <member name="M:TonyBaloney.St2.Client.Exceptions.InvalidTokenException.#ctor(System.String)"> <summary> Initializes a new instance of the TonyBaloney.St2.Client.Exceptions.InvalidTokenException class. </summary> <param name="message"> The message. </param> </member> <member name="T:TonyBaloney.St2.Client.AuthExtensions"> <summary> An authentication extensions. </summary> </member> <member name="M:TonyBaloney.St2.Client.AuthExtensions.AddXAuthToken(System.Net.Http.HttpClient,TonyBaloney.St2.Client.Models.TokenResponse)"> <summary> A HttpClient extension method that adds an x-auth-token to the client headers </summary> <param name="client"> The client to act on. </param> <param name="token"> The token. </param> </member> <member name="T:TonyBaloney.St2.Client.ISt2Client"> <summary> Interface for StackStorm API client. </summary> </member> <member name="M:TonyBaloney.St2.Client.ISt2Client.RefreshTokenAsync"> <summary> Refresh the auth token. </summary> </member> <member name="M:TonyBaloney.St2.Client.ISt2Client.GetApiRequestAsync``1(System.String)"> <summary> Make an asynchronous GET request to the API. </summary> <typeparam name="TResponseType"> Expected Type of the response. </typeparam> <param name="url"> URL of the GET request. </param> <returns> The Typed response. </returns> </member> <member name="M:TonyBaloney.St2.Client.ISt2Client.PostApiRequestAsync``2(System.String,``1)"> <summary> Make an asynchronous POST request to the API. </summary> <typeparam name="TResponseType"> Expected Type of the response. </typeparam> <typeparam name="TRequestType"> Expected Type of of the request message. </typeparam> <param name="url"> URL of the POST request. </param> <param name="request"> The request. </param> <returns> The Typed response. </returns> </member> <member name="M:TonyBaloney.St2.Client.ISt2Client.DeleteApiRequestAsync(System.String)"> <summary> Make a DELETE request to the API. </summary> <param name="url"> URL of the request. </param> </member> <member name="M:TonyBaloney.St2.Client.ISt2Client.HasToken"> <summary> Query if this object has a token. </summary> <returns> true if token, false if not. </returns> </member> <member name="P:TonyBaloney.St2.Client.ISt2Client.Actions"> <summary> Accessor for the Actions related methods </summary> <value> The actions accessor. </value> </member> <member name="P:TonyBaloney.St2.Client.ISt2Client.Packs"> <summary> Accessor for the Packs related methods. </summary> <value> The Packs accessor. </value> </member> <member name="P:TonyBaloney.St2.Client.ISt2Client.Executions"> <summary> Accessor for the Executions related methods. </summary> <value> The Executions accessor. </value> </member> <member name="P:TonyBaloney.St2.Client.ISt2Client.Rules"> <summary> Accessor for the Rules related methods. </summary> <value> The Rules accessor. </value> </member> <member name="T:TonyBaloney.St2.Client.St2Client"> <summary> StackStorm API Client. </summary> </member> <member name="F:TonyBaloney.St2.Client.St2Client._username"> <summary> The username. </summary> </member> <member name="F:TonyBaloney.St2.Client.St2Client._password"> <summary> The password. </summary> </member> <member name="F:TonyBaloney.St2.Client.St2Client._authUrl"> <summary> URL of the authentication endpoint. </summary> </member> <member name="F:TonyBaloney.St2.Client.St2Client._apiUrl"> <summary> URL of the API. </summary> </member> <member name="F:TonyBaloney.St2.Client.St2Client._token"> <summary> The token. </summary> </member> <member name="M:TonyBaloney.St2.Client.St2Client.#ctor(System.String,System.String,System.String,System.String,System.Boolean)"> <summary> Initializes a new instance of the TonyBaloney.St2.Client.St2Client class. </summary> <exception cref="T:System.ArgumentException">Thrown when one or more arguments have unsupported or illegal values. </exception> <param name="authUrl"> URL of the authentication endpoint. </param> <param name="apiUrl"> URL of the API. </param> <param name="username"> The username. </param> <param name="password"> The password. </param> <param name="ignoreCertificateValidation"> true to ignore certificate validation. </param> </member> <member name="M:TonyBaloney.St2.Client.St2Client.RefreshTokenAsync"> <summary> Refresh the auth token. </summary> <returns> A Task. </returns> <seealso cref="M:TonyBaloney.St2.Client.ISt2Client.RefreshTokenAsync()"/> </member> <member name="M:TonyBaloney.St2.Client.St2Client.GetApiRequestAsync``1(System.String)"> <summary> Make an asynchronous GET request to the API. </summary> <typeparam name="TResponseType"> Expected Type of the response. </typeparam> <param name="url"> URL of the GET request. </param> <returns> The Typed response. </returns> <seealso cref="M:TonyBaloney.St2.Client.ISt2Client.GetApiRequestAsync{TResponseType}(string)"/> </member> <member name="M:TonyBaloney.St2.Client.St2Client.PostApiRequestAsync``2(System.String,``1)"> <summary> Make an asynchronous POST request to the API. </summary> <typeparam name="TResponseType"> Expected Type of the response. </typeparam> <typeparam name="TRequestType"> Expected Type of of the request message. </typeparam> <param name="url"> URL of the POST request. </param> <param name="request"> The request. </param> <returns> The Typed response. </returns> <seealso cref="M:TonyBaloney.St2.Client.ISt2Client.PostApiRequestAsync{TResponseType,TRequestType}(string,TRequestType)"/> </member> <member name="M:TonyBaloney.St2.Client.St2Client.DeleteApiRequestAsync(System.String)"> <summary> Make a DELETE request to the API. </summary> <param name="url"> URL of the request. </param> <returns> A Task. </returns> <seealso cref="M:TonyBaloney.St2.Client.ISt2Client.DeleteApiRequestAsync(string)"/> </member> <member name="P:TonyBaloney.St2.Client.St2Client.Actions"> <summary> Accessor for the Actions related methods. </summary> <value> The actions accessor. </value> <seealso cref="P:TonyBaloney.St2.Client.ISt2Client.Actions"/> </member> <member name="P:TonyBaloney.St2.Client.St2Client.Packs"> <summary> Accessor for the Packs related methods. </summary> <value> The Packs accessor. </value> <seealso cref="P:TonyBaloney.St2.Client.ISt2Client.Packs"/> </member> <member name="P:TonyBaloney.St2.Client.St2Client.Executions"> <summary> Accessor for the Executions related methods. </summary> <value> The Executions accessor. </value> <seealso cref="P:TonyBaloney.St2.Client.ISt2Client.Executions"/> </member> <member name="P:TonyBaloney.St2.Client.St2Client.Rules"> <summary> Accessor for the Rules related methods. </summary> <value> The Rules accessor. </value> </member> </members> </doc> |