Package org.kohsuke.github
Class GHMarketplaceListAccountBuilder
- java.lang.Object
-
- org.kohsuke.github.GHMarketplaceListAccountBuilder
-
public class GHMarketplaceListAccountBuilder extends Object
Returns any accounts associated with a plan, including free plans- Author:
- Paulo Miguel Almeida
- See Also:
GHMarketplacePlan.listAccounts()
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GHMarketplaceListAccountBuilder.Sort
The enum Sort.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PagedIterable<GHMarketplaceAccountPlan>
createRequest()
List any accounts associated with the plan specified on construction with all the order/sort parameters set.GHMarketplaceListAccountBuilder
direction(GHDirection direction)
Orders the GitHub accounts results, Can be one of asc or desc.GHMarketplaceListAccountBuilder
sort(GHMarketplaceListAccountBuilder.Sort sort)
Sorts the GitHub accounts by the date they were created or last updated.
-
-
-
Method Detail
-
sort
public GHMarketplaceListAccountBuilder sort(GHMarketplaceListAccountBuilder.Sort sort)
Sorts the GitHub accounts by the date they were created or last updated. Can be one of created or updated.If omitted, the default sorting strategy will be "CREATED"
- Parameters:
sort
- the sort strategy- Returns:
- a GHMarketplaceListAccountBuilder
-
direction
public GHMarketplaceListAccountBuilder direction(GHDirection direction)
Orders the GitHub accounts results, Can be one of asc or desc. Ignored without the sort parameter.- Parameters:
direction
- the order strategy- Returns:
- a GHMarketplaceListAccountBuilder
-
createRequest
public PagedIterable<GHMarketplaceAccountPlan> createRequest() throws IOException
List any accounts associated with the plan specified on construction with all the order/sort parameters set.GitHub Apps must use a JWT to access this endpoint.
OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.
- Returns:
- a paged iterable instance of GHMarketplaceAccountPlan
- Throws:
IOException
- on error
-
-