SubsocialApi | Subsocial JS SDK

- Defined in packages/api/src/api/subsocial.ts:206
Find and load post with their extension and owner's profile and space (if defined).

Parameters
- id: AnyPostId
Returns Promise<PostWithAllDetails>

findPostWithSomeDetails

findPostWithSomeDetails(__namedParameters: FindPostWithDetailsQuery): Promise<PostWithSomeDetails>

- Defined in packages/api/src/api/subsocial.ts:191
Find and load post with their extension and owner's profile (if defined).

Parameters
- __namedParameters: FindPostWithDetailsQuery
Returns Promise<PostWithSomeDetails>

findPosts

findPosts(filter: FindStructs<AnyPostId>): Promise<CommonData<Post, PostContent>[]>

Inherited from BasicSubsocialApi.findPosts
- Defined in packages/api/src/api/basic-subsocial.ts:84
Find and load an array of posts

Parameters
- filter: FindStructs<AnyPostId>
Returns Promise<CommonData<Post, PostContent>[]>

findPostsWithAllDetails

findPostsWithAllDetails(__namedParameters: FindStructs<AnyPostId>): Promise<PostWithAllDetails[]>

- Defined in packages/api/src/api/subsocial.ts:110
Find and load posts with their extension, owner's profile and space (if defined).

Parameters
- __namedParameters: FindStructs<AnyPostId>
Returns Promise<PostWithAllDetails[]>

findPostsWithSomeDetails

findPostsWithSomeDetails(filter: FindPostsWithDetailsQuery): Promise<PostWithSomeDetails[]>

- Defined in packages/api/src/api/subsocial.ts:94
Find and load posts with their extension and owner's profile (if defined).

Parameters
- filter: FindPostsWithDetailsQuery
Returns Promise<PostWithSomeDetails[]>

findProfile

findProfile(id: AnyAccountId): Promise<ProfileData>

Inherited from BasicSubsocialApi.findProfile
- Defined in packages/api/src/api/basic-subsocial.ts:122
Find and load single profile

Parameters
- id: AnyAccountId
Returns Promise<ProfileData>

findProfiles

findProfiles(ids: AnyAccountId[]): Promise<ProfileData[]>

Inherited from BasicSubsocialApi.findProfiles
- Defined in packages/api/src/api/basic-subsocial.ts:97
Find and load an array of profiles

Parameters
- ids: AnyAccountId[]
Returns Promise<ProfileData[]>

findPublicPost

findPublicPost(id: AnySpaceId): Promise<CommonData<Post, PostContent>>

- Defined in packages/api/src/api/subsocial.ts:170
Find and load information about a public post from Subsocial blockchain and IPFS using post id.

Post is considered public if it meets the next conditions:
- The hidden field on it's blockchain structure is false.
- And there is a corresponding JSON file that represents the post's content on IPFS.
Parameters
- id: AnySpaceId
  
  Id of desired post.
Returns Promise<CommonData<Post, PostContent>>

Data about desired post aggregated from blockchain and IPFS. If no corresponding post to given id, undefined is returned.

findPublicPostWithAllDetails

findPublicPostWithAllDetails(id: AnyPostId): Promise<PostWithAllDetails>

- Defined in packages/api/src/api/subsocial.ts:211
Find and load posts that have hidden == false field in Substrate struct and their IPFS content is not empty with their extension and owner's profile and space (if defined).

Parameters
- id: AnyPostId
Returns Promise<PostWithAllDetails>

findPublicPostWithSomeDetails

findPublicPostWithSomeDetails(__namedParameters: FindPostWithDetailsQuery): Promise<PostWithSomeDetails>

- Defined in packages/api/src/api/subsocial.ts:196
Find and load post that have hidden == false field in Substrate struct and their IPFS content is not empty with their extension and owner's profile (if defined).

Parameters
- __namedParameters: FindPostWithDetailsQuery
Returns Promise<PostWithSomeDetails>

findPublicPosts

findPublicPosts(ids: AnySpaceId[]): Promise<CommonData<Post, PostContent>[]>

- Defined in packages/api/src/api/subsocial.ts:72
Find and load an array of information about public posts from Subsocial blockchain and IPFS by a given array of post ids.

Post is considered public if it meets the next conditions:
- The hidden field on its' blockchain structure is false.
- And there is a corresponding JSON file that represents the post's content on IPFS.
Parameters
- ids: AnySpaceId[]
  
  An array of ids of desired posts.
Returns Promise<CommonData<Post, PostContent>[]>

An array of data about desired posts aggregated from Subsocial blockchain and IPFS. If no corresponding posts to given array of ids, an empty array is returned.

findPublicPostsWithAllDetails

findPublicPostsWithAllDetails(ids: AnyPostId[]): Promise<PostWithAllDetails[]>

- Defined in packages/api/src/api/subsocial.ts:115
Find and load posts that have hidden == false field in Substrate struct and their IPFS content is not empty with their extension and owner's profile and space (if defined).

Parameters
- ids: AnyPostId[]
Returns Promise<PostWithAllDetails[]>

findPublicPostsWithSomeDetails

findPublicPostsWithSomeDetails(filter: FindPostsWithDetailsQuery): Promise<PostWithSomeDetails[]>

- Defined in packages/api/src/api/subsocial.ts:100
Find and load posts that have hidden == false field in Substrate struct and their IPFS content is not empty with their extension and owner's profile (if defined).

Parameters
- filter: FindPostsWithDetailsQuery
Returns Promise<PostWithSomeDetails[]>

findPublicSpace

findPublicSpace(id: AnySpaceId): Promise<CommonData<Space, SpaceContent>>

- Defined in packages/api/src/api/subsocial.ts:138
Find and load information about a public space from Subsocial blockchain and IPFS using space id.

Space is considered public if it meets these conditions:
- The hidden field on it's blockchain structure is false.
- And there is a corresponding JSON file that represents the space's content on IPFS.
Parameters
- id: AnySpaceId
  
  Id of desired space.
Returns Promise<CommonData<Space, SpaceContent>>

Data about desired space aggregated from blockchain and IPFS. If no corresponding space to given id, undefined is returned.

findPublicSpaces

findPublicSpaces(ids: AnySpaceId[]): Promise<CommonData<Space, SpaceContent>[]>

- Defined in packages/api/src/api/subsocial.ts:33
Find and load an array of information about public spaces from Subsocial blockchain and IPFS by a given array of space ids.

Space is considered public if it meets the next conditions:
- The hidden field on its' blockchain structure is false.
- And there is a corresponding JSON file that represents the space's content on IPFS.
Parameters
- ids: AnySpaceId[]
  
  An array of ids of desired spaces.
Returns Promise<CommonData<Space, SpaceContent>[]>

An array of data about desired spaces aggregated from Subsocial blockchain and IPFS. If no corresponding spaces to given array of ids, an empty array is returned.

findSpace

findSpace(__namedParameters: FindStruct<AnySpaceId>): Promise<CommonData<Space, SpaceContent>>

Inherited from BasicSubsocialApi.findSpace
- Defined in packages/api/src/api/basic-subsocial.ts:114
Find and load single space

Parameters
- __namedParameters: FindStruct<AnySpaceId>
Returns Promise<CommonData<Space, SpaceContent>>

findSpaces

findSpaces(filter: FindStructs<AnySpaceId>): Promise<CommonData<Space, SpaceContent>[]>

Inherited from BasicSubsocialApi.findSpaces
- Defined in packages/api/src/api/basic-subsocial.ts:72
Find and load an array of spaces

Parameters
- filter: FindStructs<AnySpaceId>
Returns Promise<CommonData<Space, SpaceContent>[]>

findUnlistedPost

findUnlistedPost(id: AnySpaceId): Promise<CommonData<Post, PostContent>>

- Defined in packages/api/src/api/subsocial.ts:186
Find and load information about an unlisted post from blockchain and from IPFS by a given post id.

Post is considered unlisted if it meets either of these conditions:
- The hidden field on it's blockchain structure is true.
- Or there is no corresponding JSON file that represents the post's content on IPFS.
Parameters
- id: AnySpaceId
  
  Id of desired post.
Returns Promise<CommonData<Post, PostContent>>

Data about desired post aggregated from blockchain and IPFS. If no corresponding post to given id, undefined is returned.

findUnlistedPostWithAllDetails

findUnlistedPostWithAllDetails(id: AnyPostId): Promise<PostWithAllDetails>

- Defined in packages/api/src/api/subsocial.ts:216
Find and load posts that have hidden == true field in Substrate struct and their IPFS content is not empty with their extension and owner's profile and space (if defined).

Parameters
- id: AnyPostId
Returns Promise<PostWithAllDetails>

findUnlistedPostWithSomeDetails

findUnlistedPostWithSomeDetails(__namedParameters: FindPostWithDetailsQuery): Promise<PostWithSomeDetails>

- Defined in packages/api/src/api/subsocial.ts:201
Find and load post that have hidden == true field in Substrate struct and their IPFS content is not empty with their extension and owner's profile (if defined).

Parameters
- __namedParameters: FindPostWithDetailsQuery
Returns Promise<PostWithSomeDetails>

findUnlistedPosts

findUnlistedPosts(ids: AnySpaceId[]): Promise<CommonData<Post, PostContent>[]>

- Defined in packages/api/src/api/subsocial.ts:89
Find and load an array of information about unlisted posts from Subsocial blockchain and IPFS by a given array of post ids.

Post is considered unlisted if it meets either of these conditions:
- The hidden field on it's blockchain structure is true.
- Or there is no corresponding JSON file that represents the post's content on IPFS.
Parameters
- ids: AnySpaceId[]
  
  An array of ids of desired posts
Returns Promise<CommonData<Post, PostContent>[]>

An array of data about desired posts aggregated from Subsocial blockchain and IPFS. If no corresponding posts to given array of ids, an empty array is returned.

findUnlistedPostsWithAllDetails

findUnlistedPostsWithAllDetails(ids: AnyPostId[]): Promise<PostWithAllDetails[]>

- Defined in packages/api/src/api/subsocial.ts:120
Find and load posts that have hidden == true field in Substrate struct and their IPFS content is not empty with their extension and owner's profile and space (if defined).

Parameters
- ids: AnyPostId[]
Returns Promise<PostWithAllDetails[]>

findUnlistedPostsWithSomeDetails

findUnlistedPostsWithSomeDetails(filter: FindPostsWithDetailsQuery): Promise<PostWithSomeDetails[]>

- Defined in packages/api/src/api/subsocial.ts:105
Find and load posts that have hidden == true field in Substrate struct and their IPFS content is not empty with their extension and owner's profile (if defined).

Parameters
- filter: FindPostsWithDetailsQuery
Returns Promise<PostWithSomeDetails[]>

findUnlistedSpace

findUnlistedSpace(id: AnySpaceId): Promise<CommonData<Space, SpaceContent>>

- Defined in packages/api/src/api/subsocial.ts:154
Find and load information about an unlisted space from blockchain and from IPFS by a given space id.

Space is considered unlisted if it meets either of these conditions:
- The hidden field on it's blockchain structure is true.
- Or there is no corresponding JSON file that represents the space's content on IPFS.
Parameters
- id: AnySpaceId
  
  Id of desired space.
Returns Promise<CommonData<Space, SpaceContent>>

Data about a desired space aggregated from blockchain and IPFS. If no corresponding space to given id, undefined is returned.

findUnlistedSpaces

findUnlistedSpaces(ids: AnySpaceId[]): Promise<CommonData<Space, SpaceContent>[]>

- Defined in packages/api/src/api/subsocial.ts:50
Find and load an array of information about unlisted spaces from Subsocial blockchain and IPFS by a given array of space ids.

Space is considered unlisted if it meets either of these conditions:
- The hidden field on it's blockchain structure is true.
- Or there is no corresponding JSON file that represents the space's content on IPFS.
Parameters
- ids: AnySpaceId[]
  
  An array of ids of desired spaces.
Returns Promise<CommonData<Space, SpaceContent>[]>

An array of data about desired spaces aggregated from Subsocial blockchain and IPFS. If no corresponding spaces to given array of ids, an empty array is returned.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

props: SubsocialApiProps

Returns SubsocialApi

Properties

Private structFinders

Accessors

ipfs

Returns SubsocialIpfsApi

substrate

Returns SubsocialSubstrateApi

Methods

findAllPosts

Parameters

ids: AnySpaceId[]

Returns Promise<CommonData<Post, PostContent>[]>

findAllSpaces

Parameters

ids: AnySpaceId[]

Returns Promise<CommonData<Space, SpaceContent>[]>

findPost

Parameters

__namedParameters: FindStruct<AnyPostId>

Returns Promise<CommonData<Post, PostContent>>

findPostWithAllDetails

Parameters

id: AnyPostId

Returns Promise<PostWithAllDetails>

findPostWithSomeDetails

Parameters

__namedParameters: FindPostWithDetailsQuery

Returns Promise<PostWithSomeDetails>

findPosts

Parameters

filter: FindStructs<AnyPostId>

Returns Promise<CommonData<Post, PostContent>[]>

findPostsWithAllDetails

Parameters

__namedParameters: FindStructs<AnyPostId>

Returns Promise<PostWithAllDetails[]>

findPostsWithSomeDetails

Parameters

filter: FindPostsWithDetailsQuery

Returns Promise<PostWithSomeDetails[]>

findProfile

Parameters

id: AnyAccountId

Returns Promise<ProfileData>

findProfiles

Parameters

ids: AnyAccountId[]

Returns Promise<ProfileData[]>

findPublicPost

Parameters

id: AnySpaceId

Returns Promise<CommonData<Post, PostContent>>

findPublicPostWithAllDetails

Parameters

id: AnyPostId

Returns Promise<PostWithAllDetails>

findPublicPostWithSomeDetails

Parameters

__namedParameters: FindPostWithDetailsQuery

Returns Promise<PostWithSomeDetails>

findPublicPosts

Parameters

ids: AnySpaceId[]

Returns Promise<CommonData<Post, PostContent>[]>

findPublicPostsWithAllDetails

Parameters

ids: AnyPostId[]

Returns Promise<PostWithAllDetails[]>

findPublicPostsWithSomeDetails