채널 관리 기능¶

Manage Client(클라이언트)¶

class ManageClient(channel_id: str, client: Client)¶

치지직(네이버 스트리밍 서비스)의 채널 관리 기능을 제공하는 객체입니다.

async add_prohibit_word(word: str) → ProhibitWord | None¶

채팅 금칙어를 추가합니다.

매개변수:: word (str) – 금지할 단어입니다.
반환:: 생성된 금칙어 단어를 반환합니다.
반환 형식:: Optional[ProhibitWord]

async add_restrict(user: str | PartialUser) → PartialUser¶

사용자를 채널에서 활동을 하지못하도록 제한합니다.

매개변수:: user (str | ParticleUser) – 활동 제한할 사용자를 입력합니다. 대신에 사용자의 ID 또는 닉네임을 사용할 수 있습니다.
반환:: 활동이 제한된 사용자의 정보가 담긴 객체입니다.
반환 형식:: ParticleUser

async add_role(user: str | PartialUser, role: UserRole) → PartialUser¶

사용자에게 채널에서 특정 권한을 부여합니다.

매개변수:

user (str | ParticleUser) – 권한을 부여할 사용자를 입력합니다. 대신에 사용자 ID 또는 닉네임을 사용할 수 있습니다.
role (UserRole) – 사용자에게 부여할 채널 권한입니다. 권한은 UserRole.chat_manager , UserRole.settlement_manager , UserRole.channel_manager 만 부여할 수 습니다. 다른 권한을 인수로 넣으면, TypeError 예외가 발생합니다.

반환:

권한이 추가된 사용자의 정보가 담긴 객체를 반환받습니다.

반환 형식:

ParticleUser

async chat_activity_count(user: str | PartialUser) → ChatActivityCount¶

사용자의 활동 정보를 가져옵니다.

매개변수:

user (str | ParticleUser) – 활동 정보를 가져올 사용자의 객체입니다. 대신에 사용자 ID 또는 닉네임을 사용할 수 있습니다.

반환:

ChatActivityCount – 사용자 활동 정보가 담긴 Chat Activitiy Count 객체를 반환합니다.객체에는 사용자가 임시 제한 조치를 당한 횟수,
활동 제한을 당한 횟수와 사용자가 보낸 메시지의 개수를 담고 있습니다.

async close()¶: 치지직과 연결을 종료합니다.

async edit_prohibit_word(prohibit_word: ProhibitWord | int, word: str) → ProhibitWord | None¶

금칙어를 수정합니다.

매개변수:

prohibit_word (ProhibitWord | int) – 수정할 금칙어의 객체입니다. 대신에 금칙어 ID를 입력할 수 있습니다.
word (str) – 새롭게 수정할 금칙어입니다.

반환:

수정된 금칙어가 담긴 객체를 반환받습니다.

반환 형식:

Optional[ProhibitWord]

async followers(page: int = 0, size: int = 50, sort_type: SortType = SortType.recent) → ManageResult[ManageFollower]¶

채널의 팔로워 정보를 가져옵니다.

매개변수:

page (Optional[int]) – 페이지 번호입니다. 기본 값은 0 입니다.
size (Optional[int]) – 한 번에 불러올 팔로우 수입니다. 기본 값은 50 입니다.
sort_type (Optional[SortType]) – 불러올 순서를 정의합니다. 기본 값은 :attr:`SortType.recent`입니다.

반환:

팔로워 정보가 담긴 ManageResult 객체를 반환받습니다.

반환 형식:

ManageResult[ManageFollower]

async get_chat_rule() → str¶

채팅 규칙을 불러옵니다.

반환:: 채팅 규칙을 반환받습니다.
반환 형식:: str

async get_prohbit_word(word: str) → ProhibitWord | None¶

단어로 금칙어를 불러옵니다. 검색된 결과가 없을 경우 None을 반환합니다.

매개변수:: word (str) – 금칙어를 찾을 단어입니다.
반환:: 설정된 금칙어 중에 단어가 포함되어 있으면, 금칙어 정보가 담긴 ProhibitWord 객체를 반환합니다.
반환 형식:: Optional[ProhibitWord]

async get_prohibit_words() → List[ProhibitWord]¶

모든 금칙어를 불러옵니다.

반환:: 모든 금칙어 정보가 담긴 객체를 반환합니다.
반환 형식:: List[ProhibitWord]

property is_closed: bool¶: 치지직 연결을 종료한 유/무를 불러옵니다.

async live_replay(page: int = 0, size: int = 50) → ManageResult[ManageVideo]¶

채널의 라이브(다시보기)를 불러옵니다.

매개변수:

page (Optional[int]) – 페이지 번호입니다. 기본 값은 0 입니다.
size (Optional[int]) – 한 번에 불러올 다시보기 영상의 수입니다. 기본 값은 50 입니다.

반환:

다시보기 정보가 담긴 ManageResult 객체를 반환받습니다.

반환 형식:

ManageResult[ManageVideo]

async remove_prohibit_word(prohibit_word: ProhibitWord | int) → None¶

금칙어를 삭제합니다.

매개변수:: prohibit_word (ProhibitWord | int) – 삭제할 금칙어의 객체입니다. 대신에 금칙어 ID를 입력할 수 있습니다.

async remove_prohibit_words() → None¶: 모든 금칙어를 삭제합니다.

async remove_restrict(user: str | PartialUser) → None¶

활동제한에 등록된 사용자를 제거합니다. / 채널에서 활동할 수 있도록 활동제한을 해제해줍니다.

매개변수:: user (str | ParticleUser) – 활동 제한을 해제할 사용자 객체를 입력합니다. 대신에 사용자 ID 또는 닉네임을 사용할 수 있습니다.
반환:: 활동 제한이 해제된 사용자의 정보가 담긴 객체를 반환합니다.
반환 형식:: ParticleUser

async remove_role(user: str | PartialUser) → None¶

사용자의 모든 채널 관리 권한을 제거합니다.

매개변수:: user (str | ParticleUser) – 관리 권한을 해제할 사용자 객체를 입력합니다. 대신에 사용자 ID 또는 닉네임을 사용할 수 있습니다.

async restrict(page: int = 0, size: int = 50, nickname: str | None = None) → ManageResult[UnrestrictRequest]¶

채널의 활동 제한된 사용자를 불러옵니다.

매개변수:

page (Optional[int]) – 페이지 번호입니다. 기본 값은 0 입니다.
size (Optional[int]) – 한 번에 불러올 활동제한된 사용자의 수입니다. 기본 값은 50 입니다.
nickname (Optional[str]) – 닉네임으로 활동제한된 사용자를 불러옵니다. 기본 값은 None 입니다.

반환:

활동제한 정보가 담긴 ManageResult 객체를 반환받습니다.

반환 형식:

ManageResult[RestrictUser]

async set_chat_rule(word: str) → None¶

채팅 규칙을 설정합니다.

매개변수:: word (str) – 설정할 채팅 규칙입니다.

async stream() → Stream¶

스트리밍 방송을 위한 스트림 키를 불러옵니다.

반환:: 스트림 키를 반환받습니다.
반환 형식:: Stream

async subcribers(page: int = 0, size: int = 50, sort_type: SortType = SortType.recent, publish_period: Literal[1, 3, 6] | None = None, tier: SubscriberTier | None = None, nickname: str | None = None) → ManageResult[ManageSubcriber]¶

채널의 구독자를 불러옵니다.

매개변수:

page (Optional[int]) – 페이지 번호입니다. 기본 값은 0 입니다.
size (Optional[int]) – 한 번에 불러올 구독한 사용자의 수입니다. 기본 값은 50 입니다.
sort_type (Optional[SortType]) – 불러올 순서를 정의합니다. 기본 값은 :attr:`SortType.recent`입니다.
publish_period (Optional[Literal[1, 3, 6]]) – 구독 기간으로 구독한 사용자를 필터하여 불러옵니다. 기본 값은 None 입니다.
tier (Optional[SubscriberTier]) – 티어로 구독한 사용자를 필터하여 불러옵니다. 기본 값은 None 입니다.
nickname (Optional[str]) – 닉네임으로 구독한 사용자를 불러옵니다. 기본 값은 None 입니다.

반환:

채널의 구독자 정보가 담긴 ManageResult 객체를 반환받습니다.

반환 형식:

ManageResult[ManageSubcriber]

async unrestrict_requests(page: int = 0, size: int = 50, nickname: str | None = None) → ManageResult[UnrestrictRequest]¶

Get unrestrict activity requests of channel.

매개변수:

page (Optional[int]) – 페이지 번호입니다. 기본 값은 0 입니다.
size (Optional[int]) – 한 번에 불러올 활동제한 해제 요청의 수입니다. 기본 값은 50 입니다.
nickname (Optional[str]) – 활동제한 요청을 닉네임으로 필터링합니다. 기본 값은 None 입니다.

반환:

Returns a ManageResult containing the unrestrict requests.

반환 형식:

ManageResult[UnrestrictRequest]

async videos(page: int = 0, size: int = 50) → ManageResult[ManageVideo]¶

채널에 업로드된 영상을 불러옵니다.

매개변수:

page (Optional[int]) – 페이지 번호입니다. 기본 값은 0 입니다.
size (Optional[int]) – 한 번에 불러올 영상의 수입니다. 기본 값은 50 입니다.

반환:

영상 정보가 담긴 ManageResult 객체를 반환받습니다.

반환 형식:

ManageResult[ManageVideo]

Enumerations¶

class SortType¶

longer = 'LONGER'¶

recent = 'RECENT'¶

class SubscriberTier¶

tier1 = 'TIER_1'¶

tier2 = 'TIER_2'¶

Chat Activity Count¶

class ChatActivityCount¶

chat_message_count: int¶

restrict: bool¶

restrict_count: int¶

temporary_restrict: bool¶

temporary_restrict_count: int¶

Search Result¶

class ManageResult¶

data: List[T]¶

page: int¶

size: int¶

total_count: int¶

total_pages: int¶

class ManageSubcriber¶

created_date: datetime¶

nickname: str | None¶

profile_image_url: str | None¶

publish_period: int¶

tier: str¶

total_month: int¶

twitch_month: int | None¶

user_id_hash: str | None¶

verified_mark: bool¶

class ManageFollower¶

channel_following: FollowingInfo¶

following: FollowingInfo¶

user: PartialUser¶

class RestrictUser¶

created_date: datetime¶

execute_nickname: str¶

nickname: str¶

async remove_restrict()¶: 활동제한에 등록된 사용자를 제거합니다. 채널에서 활동할 수 있도록 활동제한을 해제해줍니다.

seq: int¶

user_id_hash: str¶

class ManageVideo¶

comment_count: int¶

created_date: Annotated[datetime, BeforeValidator(func=special_date_parsing_validator)]¶

deleted: bool¶

exposure: bool¶

exposure_button: str¶

like_count: int¶

live_accumulate_count: int¶

live_id: int | None¶

live_open_date: Annotated[datetime | None, BeforeValidator(func=special_date_parsing_validator)]¶

live_unique_view_count: int¶

manual_publishable: bool¶

publish: bool¶

publish_type: str¶

read_count: int¶

vod_status: str¶

class FollowingInfo¶

follow_date: datetime | None¶

following: bool¶

notification: bool¶

Prohibit Word¶

class ProhibitWord¶

created_date: datetime¶

async edit(word: str)¶

금칙된 단어를 수정합니다.

매개변수:: word (str) – 새롭게 수정할 금칙어입니다.

nickname: str¶

prohibit_word: str¶

prohibit_word_no: int¶

async remove()¶: 금칙된 단어를 제거합니다.

Stream¶

class Stream¶

stream_key: str¶

stream_seq: int¶

stream_url: str¶