Class Social

Hierarchy (view full)

ApillonModule
- Social

Index

Constructors

Properties

HUBS_API_PREFIX CHANNELS_API_PREFIX config

Methods

listHubs listChannels createHub createChannel hub channel

Constructors

constructor

new Social(config?): Social
Parameters
- Optional config: ApillonConfig
Returns Social
Inherited from ApillonModule.constructor
- Defined in lib/apillon.ts:36

Properties

`Private` HUBS_API_PREFIX

HUBS_API_PREFIX: string = '/social/hubs'

`Private` CHANNELS_API_PREFIX

CHANNELS_API_PREFIX: string = '/social/channels'

`Protected` config

config: ApillonConfig

Methods

listHubs

listHubs(params?): Promise<IApillonList<SocialHub>>
Lists all hubs with optional filters.
Parameters
- Optional params: IApillonPagination
  Optional filters for listing hubs.
Returns Promise<IApillonList<SocialHub>>
A list of Hub instances.
- Defined in modules/social/social.ts:22

listChannels

listChannels(params?): Promise<IApillonList<SocialChannel>>
Lists all channels with optional filters.
Parameters
- Optional params: IChannelFilters
  Optional filters for listing channels.
Returns Promise<IApillonList<SocialChannel>>
A list of Channel instances.
- Defined in modules/social/social.ts:40

createHub

createHub(hubData): Promise<SocialHub>
Creates a new hub.
Parameters
- hubData: ICreateHub
  Data for creating the hub.
Returns Promise<SocialHub>
The created Hub instance.
- Defined in modules/social/social.ts:61

createChannel

createChannel(channelData): Promise<SocialChannel>
Creates a new channel.
Parameters
- channelData: ICreateChannel
  Data for creating the channel.
Returns Promise<SocialChannel>
The created Channel instance.
- Defined in modules/social/social.ts:74

hub

hub(uuid): SocialHub
Parameters
- uuid: string
  Unique hub identifier.
Returns SocialHub
An instance of Hub.
- Defined in modules/social/social.ts:87

channel

channel(uuid): SocialChannel
Parameters
- uuid: string
  Unique channel identifier.
Returns SocialChannel
An instance of SocialChannel.
- Defined in modules/social/social.ts:95