View Source Tentacat.Organizations.Members (Tentacat v2.5.0)

Summary

Functions

Conceal a user's membership on an organization.

Check if a user is, publicly or privately, a member of the organization.

List of publicized members of an organization.

Check if a user is a public member of the organization.

Publicize a user's membership on an organization.

Remove a member user from an organization.

Functions

Link to this function

conceal(client, organization, user)

View Source
@spec conceal(Tentacat.Client.t(), binary(), binary()) :: Tentacat.response()

Conceal a user's membership on an organization.

Example

Tentacat.Organizations.Members.conceal "github", "mojombo"

More info at: http://developer.github.com/v3/orgs/members/#conceal-a-users-membership

Link to this function

list(client \\ %Client{}, organization, options \\ [])

View Source

List members of a organization.

The response will differ if the authenticated user is also owner of the organization.

Example

Tentacat.Organizations.Members.list "github"
Tentacat.Organizations.Members.list client, "github"
Tentacat.Organizations.Members.list client, "github", %{page: 2}

More info at: http://developer.github.com/v3/orgs/members/#members-list

Link to this function

member?(client \\ %Client{}, organization, user)

View Source
@spec member?(Tentacat.Client.t(), binary(), binary()) :: Tentacat.response()

Check if a user is, publicly or privately, a member of the organization.

Possible responses: 204, 404 or 302.

Example

Tentacat.Organizations.Members.member? "github", "mojombo"
Tentacat.Organizations.Members.member? client, "github", "mojombo"

More info at: http://developer.github.com/v3/orgs/members/#check-membership

Link to this function

public_list(client \\ %Client{}, organization)

View Source
@spec public_list(Tentacat.Client.t(), binary()) :: Tentacat.response()

List of publicized members of an organization.

Example

Tentacat.Organizations.Members.public_list "github"
Tentacat.Organizations.Members.public_list client, "github"

More info at: http://developer.github.com/v3/orgs/members/#public-members-list

Link to this function

public_member?(client \\ %Client{}, organization, user)

View Source
@spec public_member?(Tentacat.Client.t(), binary(), binary()) :: Tentacat.response()

Check if a user is a public member of the organization.

Possible responses: 204 or 404.

Example

Tentacat.Organizations.Members.public_member? "github", "mojombo"
Tentacat.Organizations.Members.public_member? client, "github", "mojombo"

More info at: http://developer.github.com/v3/orgs/members/#public-members-list

Link to this function

publicize(client, organization, user)

View Source
@spec publicize(Tentacat.Client.t(), binary(), binary()) :: Tentacat.response()

Publicize a user's membership on an organization.

Example

Tentacat.Organizations.Members.publicize "github", "mojombo"

More info at: http://developer.github.com/v3/orgs/members/#publicize-a-users-membership

Link to this function

remove(client, organization, user)

View Source
@spec remove(Tentacat.Client.t(), binary(), binary()) :: Tentacat.response()

Remove a member user from an organization.

Example

Tentacat.Organizations.Members.remove client, "github", "mojombo"

More info at: http://developer.github.com/v3/orgs/members/#remove-organization-membership