커뮤니티 라이브러리

client.community는 커뮤니티 라이브러리를 읽습니다. 커뮤니티 라이브러리는 Nodaro 팀이 선별한 캐릭터, 장소, 오브젝트의 공유 모음입니다. 라이브러리를 둘러보고 검색하고, 게시물을 읽고, 게시물을 내 계정으로 복제하고, 즐겨찾기에 추가하고, 신고해 검토를 요청할 수 있습니다. 이 메서드들은 커뮤니티 REST API를 호출합니다. 기능 자체와 초상 및 동의 규칙은 커뮤니티 라이브러리를 참조하세요.

커뮤니티 라이브러리는 다중 사용자 설치인 Nodaro Cloud와 Business 에디션에 있습니다. 단일 사용자용 Community Edition 설치는 모든 호출에 NotFoundError로 응답합니다.

메서드

게시는 SDK에 포함되어 있지 않습니다. SDK의 개인 토큰과 OAuth 토큰으로는 게시할 수 없습니다.

client.community

게시물은 CommunityCard입니다. 필드는 API가 보내는 대로 snake_case를 사용합니다. CommunityEntityType은 "character", "location", "object" 중 하나입니다.

browse(params?)

공개 게시물 한 페이지와 nextCursor를 반환합니다(GET /v1/community/browse). 다음 페이지를 받으려면 nextCursor를 cursor로 다시 전달하세요. 마지막 페이지에서는 null입니다.

browse(params?: BrowseCommunityParams): Promise<{ data: CommunityCard[]; nextCursor: string | null }>

const { data: listings, nextCursor } = await client.community.browse({
  entityType: "character",
  sort: "popular",
  limit: 20,
})

get(slug)

슬러그로 게시물 하나를 읽습니다(GET /v1/community/detail/:slug).

get(slug: string): Promise<{ data: CommunityCard }>

const { data: listing } = await client.community.get("detective-mara")

게시물이 없거나 더 이상 활성 상태가 아니면 NotFoundError가 발생합니다.

getFull(slug)

상세 페이지에 표시되는 것처럼 이미지, 보이스, 텍스트를 포함한 전체 공개 스냅샷과 함께 게시물 하나를 읽습니다(GET /v1/community/detail/:slug/full).

getFull(slug: string): Promise<{ data: CommunityFullDetail }>

const { data: detail } = await client.community.getFull("detective-mara")

favorites()

내가 즐겨찾기에 추가한 게시물을 나열합니다(GET /v1/community/favorites).

favorites(): Promise<{ data: CommunityCard[] }>

const { data: favorites } = await client.community.favorites()

clone(id, entityType)

게시물을 독립된 복사본으로 내 라이브러리에 복사합니다(POST /v1/community/listings/:id/clone). 파일이 내 저장 공간으로 복사되므로, 원본이 바뀌거나 삭제되어도 복사본은 남습니다. 새로 만든 내 에셋의 종류와 ID를 반환합니다.

clone(id: string, entityType: "character" | "location" | "object"): Promise<{ entityType: string; id: string }>

const { id: characterId } = await client.community.clone(listingId, "character")
const character = await client.characters.get(characterId)

OAuth 토큰에는 assets:write 스코프가 필요합니다. 저장 공간이 가득 차면 StorageExceededError가 발생합니다.

favorite(id)

게시물을 즐겨찾기에 추가하거나, 이미 추가되어 있으면 제거합니다(POST /v1/community/listings/:id/favorite). 바뀐 상태를 반환합니다.

favorite(id: string): Promise<{ favorited: boolean }>

const { favorited } = await client.community.favorite(listingId)

report(id, reason)

게시물을 신고해 검토를 요청합니다(POST /v1/community/listings/:id/report).

report(id: string, reason: CommunityReportReason): Promise<{ ok: true }>

await client.community.report(listingId, "real_person_no_consent")