Tentacat v0.2.0 → Overview → Tentacat → Organizations → Members

Tentacat.Organizations.Members

Summary
Functions

Summary

conceal(organization, user, client)	Conceal a `user`‘s membership on an `organization`
list(organization, client \\ %Tentacat.Client{})	List members of a `organization`. The response will differ if the authenticated user is also owner of the organization
member?(organization, user, client \\ %Tentacat.Client{})	Check if a `user` is, publicly or privately, a member of the `organization`
public_list(organization, client \\ %Tentacat.Client{})	List of publicized members of an `organization`
public_member?(organization, user, client \\ %Tentacat.Client{})	Check if a `user` is a public member of the `organization`
publicize(organization, user, client)	Publicize a `user`‘s membership on an `organization`
remove(organization, user, client)	Remove a member `user` from an `organization`

Functions

conceal(organization, user, client)

(function) # ↑

Specs:

conceal(binary, binary, Tentacat.Client.t) :: 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

list(organization, client \\ %Tentacat.Client{})

(function) # ↑

Specs:

list(binary, Tentacat.Client.t) :: Tentacat.response

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 "github", client

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

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

(function) # ↑

Specs:

member?(binary, binary, Tentacat.Client.t) :: 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? "github", "mojombo", client

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

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

(function) # ↑

Specs:

public_list(binary, Tentacat.Client.t) :: Tentacat.response

List of publicized members of an organization

Example

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

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

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

(function) # ↑

Specs:

public_member?(binary, binary, Tentacat.Client.t) :: 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? "github", "mojombo", client

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

publicize(organization, user, client)

(function) # ↑

Specs:

publicize(binary, binary, Tentacat.Client.t) :: 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

remove(organization, user, client)

(function) # ↑

Specs:

remove(binary, binary, Tentacat.Client.t) :: Tentacat.response

Remove a member user from an organization

Example

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

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