Flickrex.Flickr.Groups.Members (flickrex v0.8.1) View Source
Link to this section Summary
Functions
Get a list of the members of a group. The call must be signed on behalf of a Flickr member, and the ability to see the group membership will be determined by the Flickr member's group privileges.
Link to this section Types
Specs
arg() :: String.Chars.t()
Specs
operation() :: Flickrex.Operation.Rest.t()
Specs
opts() :: Flickrex.Rest.args()
Link to this section Functions
Specs
Get a list of the members of a group. The call must be signed on behalf of a Flickr member, and the ability to see the group membership will be determined by the Flickr member's group privileges.
This method requires authentication with "read" permission.
Arguments
group_id- Return a list of members for this group. The group must be viewable by the Flickr member on whose behalf the API call is made.
Options
membertypes- Comma separated list of member types <ul> <li>2: member</li> <li>3: moderator</li> <li>4: admin</li> </ul> By default returns all types. (Returning super rare member type "1: narwhal" isn't supported by this API method)per_page- Number of members to return per page. If this argument is omitted, it defaults to 100. The maximum allowed value is 500.page- The page of results to return. If this argument is omitted, it defaults to 1.
Example response
%{
"members" => %{
"_content" => "...\n",
"member" => [
%{
"iconfarm" => "1",
"iconserver" => "1",
"membertype" => "2",
"nsid" => "123456@N01",
"username" => "foo"
},
%{
"iconfarm" => "0",
"iconserver" => "0",
"membertype" => "4",
"nsid" => "118210@N07",
"username" => "kewlchops666"
},
%{
"iconfarm" => "0",
"iconserver" => "0",
"membertype" => "2",
"nsid" => "119377@N07",
"username" => "Alpha Shanan"
},
%{
"iconfarm" => "2",
"iconserver" => "1003",
"membertype" => "3",
"nsid" => "67783977@N00",
"username" => "fakedunstanp1"
}
],
"page" => "1",
"pages" => "1",
"perpage" => "100",
"total" => "33"
},
"stat" => "ok"
}