credentials

Documentation

Index

• type Client
  • func NewClient(cfg *ngrok.ClientConfig) *Client
  • func (c *Client) Create(ctx context.Context, arg *ngrok.CredentialCreate) (*ngrok.Credential, error)
  • func (c *Client) Delete(ctx context.Context, id string) error
  • func (c *Client) Get(ctx context.Context, id string) (*ngrok.Credential, error)
  • func (c *Client) List(paging *ngrok.Paging) *Iter
  • func (c *Client) Update(ctx context.Context, arg *ngrok.CredentialUpdate) (*ngrok.Credential, error)
• type Iter
  • func (it *Iter) Err() error
  • func (it *Iter) Item() *ngrok.Credential
  • func (it *Iter) Next(ctx context.Context) bool

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(cfg *ngrok.ClientConfig) *Client

func (*Client) Create

func (c *Client) Create(ctx context.Context, arg *ngrok.CredentialCreate) (*ngrok.Credential, error)

Create a new tunnel authtoken credential. This authtoken credential can be used to start a new tunnel session. The response to this API call is the only time the generated token is available. If you need it for future use, you must save it securely yourself.

https://ngrok.com/docs/api#api-credentials-create

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, id string) error

Delete a tunnel authtoken credential by ID

https://ngrok.com/docs/api#api-credentials-delete

func (*Client) Get

func (c *Client) Get(ctx context.Context, id string) (*ngrok.Credential, error)

Get detailed information about a tunnel authtoken credential

https://ngrok.com/docs/api#api-credentials-get

func (*Client) List

func (c *Client) List(paging *ngrok.Paging) *Iter

List all tunnel authtoken credentials on this account

https://ngrok.com/docs/api#api-credentials-list

func (*Client) Update

func (c *Client) Update(ctx context.Context, arg *ngrok.CredentialUpdate) (*ngrok.Credential, error)

Update attributes of an tunnel authtoken credential by ID

https://ngrok.com/docs/api#api-credentials-update

type Iter

type Iter struct {
	// contains filtered or unexported fields
}

Iter allows the caller to iterate through a list of values while automatically fetching new pages worth of values from the API.

func (*Iter) Err

func (it *Iter) Err() error

If Next() returned false because an error was encountered while fetching the next value Err() will return that error. A caller should always check Err() after Next() returns false.

func (*Iter) Item

func (it *Iter) Item() *ngrok.Credential

Item() returns the Credential currently pointed to by the iterator.

func (*Iter) Next

func (it *Iter) Next(ctx context.Context) bool

Next returns true if there is another value available in the iterator. If it returs true it also advances the iterator to that next available item.