Spaces

Find and load a single space#

findSpace(query: FindSpaceQuery): Promise<SpaceData | undefined>

Example:

flatApi.subsocial.findSpace({id: '1'})

Properties	Description
id	ID of the desired struct.
visibility	Filter for the visible state of the structs (see Visibility).

🆃 FindSpaceQuery: FindStruct < AnySpaceId >

🆃 SpaceData: CommonData < Space, SpaceContent >

flatApi.subsocial.findAllSpaces(ids: AnySpaceId[]): Promise<SpaceData[]>

Example:

flatApi.subsocial.findAllSpaces([ '1' ])

🆃 AnySpaceId: SpaceId | BN

🆃 SpaceData: CommonData < Space, SpaceContent >

flatApi.subsocial.findSpaces(query: FindSpacesQuery): Promise<SpaceData[]>

Example:

flatApi.subsocial.findSpaces({
  ids: [ '1', '1354', '1573', '1599', '1040' ],
  visibility: "onlyVisible",
})

Properties	Description
ids	An array of IDs of the desired structs.
visibility	Filter for the visible state of the structs (see Visibility).
withContentOnly?	Boolean.

🆃 Visibility: 'onlyVisible' | 'onlyHidden' | 'onlyPublic' | 'onlyUnlisted'

🆃 SpaceData: CommonData < Space, SpaceContent >

Load an array of information about public spaces from the Subsocial blockchain and IPFS by a given array of space ids.

A space is considered public if it meets these 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.

flatApi.subsocial.findPublicSpaces(ids: AnySpaceId[]): Promise<SpaceData[]>

Example:

flatApi.subsocial.findPublicSpaces([ '1' ])

🆃 AnySpaceId: SpaceId | BN

🆃 SpaceData: CommonData < Space, SpaceContent >

Find and load an array of information about unlisted spaces from the Subsocial blockchain and IPFS by a given array of space ids.

A space is considered unlisted if it meets either of these conditions:

The hidden field on its blockchain structure is true.
Or there is no corresponding JSON file that represents the space's content on IPFS.

flatApi.subsocial.findUnlistedSpaces(ids: AnySpaceId[]): Promise<SpaceData[]>

Example:

flatApi.subsocial.findUnlistedSpaces(['1'])

🆃 AnySpaceId: SpaceId | BN

🆃 SpaceData: CommonData < Space, SpaceContent >