redditwarp.siteprocs.subreddit_style_new.SYNC
#
- class redditwarp.siteprocs.subreddit_style_new.SYNC.SubredditStyleNewProcedures(client: Client)[source]#
Bases:
object
- class BannerUploading(outer: SubredditStyleNewProcedures)[source]#
Bases:
object
- obtain_banner_upload_lease(*, sr: str, filepath: str, mimetype: str | None = None) UploadLease [source]#
- obtain_banner_overlay_upload_lease(*, sr: str, filepath: str, mimetype: str | None = None) UploadLease [source]#
- obtain_banner_overlay_hover_upload_lease(*, sr: str, filepath: str, mimetype: str | None = None) UploadLease [source]#
- obtain_mobile_banner_upload_lease(*, sr: str, filepath: str, mimetype: str | None = None) UploadLease [source]#
- deposit_file(file: IO[bytes], upload_lease: UploadLease, *, timeout: float = 1000) None [source]#
- upload_banner(file: IO[bytes], *, sr: str, filepath: str | None = None, timeout: float = 1000) UploadLease [source]#
- upload_banner_overlay(file: IO[bytes], *, sr: str, filepath: str | None = None, timeout: float = 1000) UploadLease [source]#
- upload_banner_overlay_hover(file: IO[bytes], *, sr: str, filepath: str | None = None, timeout: float = 1000) UploadLease [source]#
- upload_mobile_banner(file: IO[bytes], *, sr: str, filepath: str | None = None, timeout: float = 1000) UploadLease [source]#
- property banner_uploading: None#
- modify_banner_settings(sr: str, *, banner_size: str | None = None, banner_background_color: str | None = None, banner_image_url: str | None = None, banner_image_display: str | None = None, banner_overlay_image_url: str | None = None, banner_overlay_image_position: str | None = None, banner_overlay_hover_image_url: str | None = None, mobile_banner_image_url: str | None = None) None [source]#
Set banner images in a subreddit.
Parameters set to
None
are ignored.Use an empty string to set a setting to its default.
- Parameters:
banner_size (Optional[str]) –
Either:
small
,medium
,large
.Empty string or any other value defaults to
small
.banner_background_color (Optional[str]) –
A hex color.
Empty string or any other value defaults to
#33a8ff
.banner_image_url (Optional[str]) –
The URL location of a banner image.
Use empty string to remove the image.
banner_image_display (Optional[str]) –
Either:
cover
,tiled
.Empty string or any other value defaults to
cover
.banner_overlay_image_url (Optional[str]) –
The URL location of a banner overlay image.
Use empty string to remove the image.
banner_overlay_image_position (Optional[str]) –
Either:
left
,center
,right
.Empty string or any other value defaults to
left
.banner_overlay_hover_image_url (Optional[str]) –
The URL location of a banner overlay hover image.
Use empty string to remove the image.
mobile_banner_image_url (Optional[str]) –
The URL location of a mobile banner image.
Use empty string to remove the image.
- Return type:
None
- Raises:
redditwarp.exceptions.RedditError –
USER_REQUIRED
:There is no user context.