redditwarp.siteprocs.flair_emoji.ASYNC

class redditwarp.siteprocs.flair_emoji.ASYNC.FlairEmojiProcedures(client: Client)

Bases: object

async retrieve(sr: str) → SubredditFlairEmojis

Get a list of all flair emojis in a subreddit.

Parameters:

sr (str) –

Returns:

A mapping from flair emoji name to FlairEmoji.

Return type:

SubredditFlairEmojis

Raises:

• redditwarp.exceptions.RedditError –

  • USER_REQUIRED:

    There is no user context.

• redditwarp.http.exceptions.StatusCodeException –

  • 403:

    The specified subreddit cannot be accessed.

  • 500:

    The specified subreddit does not exist.

class Create(outer: FlairEmojiProcedures)

Bases: object

async obtain_upload_lease(*, sr: str, filepath: str, mimetype: str | None = None) → UploadLease

async deposit_file(file: IO[bytes], upload_lease: UploadLease, *, timeout: float = 1000) → None

async upload(file: IO[bytes], *, sr: str, filepath: str | None = None, timeout: float = 1000) → UploadLease

async add(sr: str, name: str, s3_object_key: str, *, mod_only: bool = False, user_enabled: bool = True, post_enabled: bool = True) → None

property create: None

Create a new flair emoji.

Parameters:

• sr (str) –

• name (str) –

• file (IO[bytes]) –

• filepath (Optional[str]) –

• mod_only (bool) –

• post_enabled (bool) –

• user_enabled (bool) –

• timeout (float) –

Return type:

None

async set_permissions(sr: str, name: str, *, mod_only: bool = False, user_enabled: bool = True, post_enabled: bool = True) → None

Change emoji permissions.

Parameters:

• sr (str) –

• name (str) –

• mod_only (bool) –

• user_enabled (bool) –

• post_enabled (bool) –

Return type:

None

Raises:

• redditwarp.exceptions.RedditError –

  • USER_REQUIRED:

    There is no user context.

• redditwarp.http.exceptions.StatusCodeException –

  • 403:

    You do not have permission.

  • 404:

    The specified emoji doesn’t exist.

  • 500:

    • The specified subreddit does not exist.

    • The specified emoji name was empty.

async delete(sr: str, name: str) → None

Delete a flair emoji.

Parameters:

• sr (str) –

• name (str) –

Return type:

None

Raises:

• redditwarp.exceptions.RedditError –

  • USER_REQUIRED:

    There is no user context.

• redditwarp.http.exceptions.StatusCodeException –

  • 400:

    • The specified subreddit does not exist.

    • The specified emoji name was empty.

async enable_emojis_in_subreddit(sr: str) → None

Enable flair emojis in a subreddit.

Parameters:

sr (str) –

Return type:

None

Raises:

• redditwarp.exceptions.RedditError –

  • USER_REQUIRED:

    There is no user context.

• redditwarp.http.exceptions.StatusCodeException –

  • 403:

    You do not have permission.

  • 500:

    • The specified subreddit does not exist.

    • The specified subreddit was empty.

async disable_emojis_in_subreddit(sr: str) → None

Disable flair emojis in a subreddit.

Parameters:

sr (str) –

Return type:

None

(raises):

Same as enable_emojis_in_subreddit().