Skip to content

person

Accessed as client.activitypub.person; the async client mirrors it.

ActivitypubPerson

The activitypub.person namespace.

activities 

activities: ActivitypubPersonActivities = ActivitypubPersonActivities(client)

get 

get(user_id: int) -> ActivityPub

Returns the Person actor for a user.

Parameters:

Name Type Description Default
user_id int

user ID of the user

 required

Returns:

Type Description
ActivityPub

ActivityPub.

Operation ID: activitypubPerson

inbox 

inbox(user_id: int) -> None

Send to the inbox.

Parameters:

Name Type Description Default
user_id int

user ID of the user

 required

Returns:

Type Description
None

No content.

Operation ID: activitypubPersonInbox

outbox 

outbox(user_id: int) -> ForgeOutbox

List the user's recorded activity.

Parameters:

Name Type Description Default
user_id int

user ID of the user

 required

Returns:

Type Description
ForgeOutbox

Outbox.

Raises:

Type Description
ForbiddenError
  1. APIForbiddenError is a forbidden error response.

Operation ID: activitypubPersonFeed

AsyncActivitypubPerson

The activitypub.person namespace.

activities 

activities: AsyncActivitypubPersonActivities = AsyncActivitypubPersonActivities(client)

get 

get(user_id: int) -> ActivityPub

Returns the Person actor for a user.

Parameters:

Name Type Description Default
user_id int

user ID of the user

 required

Returns:

Type Description
ActivityPub

ActivityPub.

Operation ID: activitypubPerson

inbox 

inbox(user_id: int) -> None

Send to the inbox.

Parameters:

Name Type Description Default
user_id int

user ID of the user

 required

Returns:

Type Description
None

No content.

Operation ID: activitypubPersonInbox

outbox 

outbox(user_id: int) -> ForgeOutbox

List the user's recorded activity.

Parameters:

Name Type Description Default
user_id int

user ID of the user

 required

Returns:

Type Description
ForgeOutbox

Outbox.

Raises:

Type Description
ForbiddenError
  1. APIForbiddenError is a forbidden error response.

Operation ID: activitypubPersonFeed