penicillin/blue.starry.penicillin.extensions.endpoints/hasMember

hasMember

fun Lists.hasMember( listId: Long, userId: Long, vararg options: Option): ApiAction<Boolean>

Returns true if the specified user is a member of the specified list.

Receiver

Lists endpoint instance.

Return

ApiAction for Boolean.

Parameters

listId

The numerical id of the list.

userId

The ID of the user for whom to return results. Helpful for disambiguating when a valid user ID is also a valid screen name.

options

Optional. Custom parameters of this request.

fun Lists.hasMember( listId: Long, screenName: String, vararg options: Option): ApiAction<Boolean>

Returns true if the specified user is a member of the specified list.

Receiver

Lists endpoint instance.

Return

ApiAction for Boolean.

Parameters

listId

The numerical id of the list.

screenName

The screen name of the user for whom to return results. Helpful for disambiguating when a valid screen name is also a user ID.

options

Optional. Custom parameters of this request.

fun Lists.hasMember( slug: String, ownerScreenName: String, userId: Long, vararg options: Option): ApiAction<Boolean>

Returns true if the specified user is a member of the specified list.

Receiver

Lists endpoint instance.

Return

ApiAction for Boolean.

Parameters

slug

You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you'll also have to specify the list owner using the owner_id or owner_screen_name parameters.

ownerScreenName

The screen name of the user who owns the list being requested by a slug.

userId

The ID of the user for whom to return results. Helpful for disambiguating when a valid user ID is also a valid screen name.

options

Optional. Custom parameters of this request.

fun Lists.hasMember( slug: String, ownerScreenName: String, screenName: String, vararg options: Option): ApiAction<Boolean>

Returns true if the specified user is a member of the specified list.

Receiver

Lists endpoint instance.

Return

ApiAction for Boolean.

Parameters

slug

You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you'll also have to specify the list owner using the owner_id or owner_screen_name parameters.

ownerScreenName

The screen name of the user who owns the list being requested by a slug.

screenName

The screen name of the user for whom to return results. Helpful for disambiguating when a valid screen name is also a user ID.

options

Optional. Custom parameters of this request.

fun Lists.hasMember( slug: String, ownerId: Long, userId: Long, vararg options: Option): ApiAction<Boolean>

Returns true if the specified user is a member of the specified list.

Receiver

Lists endpoint instance.

Return

ApiAction for Boolean.

Parameters

slug

You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you'll also have to specify the list owner using the owner_id or owner_screen_name parameters.

ownerId

The user ID of the user who owns the list being requested by a slug.

userId

The ID of the user for whom to return results. Helpful for disambiguating when a valid user ID is also a valid screen name.

options

Optional. Custom parameters of this request.

fun Lists.hasMember( slug: String, ownerId: Long, screenName: String, vararg options: Option): ApiAction<Boolean>

Returns true if the specified user is a member of the specified list.

Receiver

Lists endpoint instance.

Return

ApiAction for Boolean.

Parameters

slug

You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you'll also have to specify the list owner using the owner_id or owner_screen_name parameters.

ownerId

The user ID of the user who owns the list being requested by a slug.

screenName

The screen name of the user for whom to return results. Helpful for disambiguating when a valid screen name is also a user ID.

options

Optional. Custom parameters of this request.