orbis.getGroup()

Returns the details of a group.

How to use?

let { data, error } = await orbis.getGroup(group_id);

Parameters

  • group_id: ID of the group

Returns

/** This is an example for the Orbis Community group */
  {
  	stream_id: "kjzl6cwe1jw14ai2gg8e0qmx2j944ppe3s3dgfk003jlb8guuybyg4m77nsrg73",
  	creator: "did:pkh:eip155:1:0x075286d1a22b083ebcaf6b7fb4cf970cfc4a18f0",
  	content: {
  		pfp: "https://arweave.net/_yefpXWgwxcbhc8UlOMvQH8-sqB0Z_57qsdKfHEHQAk",
  		name: "Orbis Community",
  		description:"Official group to discuss the Orbis protocol."
  	},
  	channels: [
  		{
  			stream_id:"kjzl6cwe1jw146dsyirmelk6u0jxlm3un1cetespick334a0i3ho3kd29cw6ecz",
  			content: {
  				name: "general",
  				type: "feed",
  				group_id: "kjzl6cwe1jw14ai2gg8e0qmx2j944ppe3s3dgfk003jlb8guuybyg4m77nsrg73"
  			}
  		}, {
  			stream_id: "kjzl6cwe1jw145gun3sei0a4puw586yxa614le1tfh434y7quv2wsm0ivhbge7x",
  			content: {
  				name: "developer-chat",
  				type: "chat",
  				group_id: "kjzl6cwe1jw14ai2gg8e0qmx2j944ppe3s3dgfk003jlb8guuybyg4m77nsrg73",
  				description: "This is the channel to use if you have questions about the Orbis SDK."}
  		}
  	],
  	count_members: 10,
  	last_activity_timestamp: 1656580635
  }

Next steps

Explore other parts of the API.

orbis.getPost()

orbis.getGroups()