module Octokit::Client::Apps
Overview
Methods for the Apps API
Direct including types
Defined in:
octokit/client/apps.crInstance Method Summary
-
#app(**options)
Get the authenticated App
-
#create_app_installation_access_token(installation : Int32, **options)
Create a new installation token
-
#create_installation_access_token(installation : Int32, **options)
alias for
#create_app_installation_access_token
-
#find_app_installations(**options) : Paginator(Octokit::Models::Installation)
Find all installations that belong to an App
-
#find_installations(**options) : Paginator(Octokit::Models::Installation)
alias for
#find_app_installations
Instance Method Detail
Get the authenticated App
@param options [Hash] A customizable set of options
@see https://developer.github.com/v3/apps/#get-the-authenticated-app
Example:
@client = Octokit.client(bearer_token: <jwt>)
@client.app
Create a new installation token
@param installation [Integer] The id of a GitHub App Installation @param options [Hash] A customizable set of options
@see https://developer.github.com/v3/apps/#create-a-new-installation-token
@return [Sawyer::Resource] An installation token
alias for #create_app_installation_access_token
Find all installations that belong to an App
@param options [Hash] A customizable set of options
@see https://developer.github.com/v3/apps/#list-installations
@return the total_count and an array of installations
alias for #find_app_installations