EventService

Incubator service can be used in the following way:

1. Import the service from our library:

import {EventService} from "@selfcommunity/api-services";

2. Create a function and put the service inside it!
The async function `searchEvents` will return the events matching the search query.

async searchEvents() {
        return await EventService.searchEvents();
       }

In case of required `params`, just add them inside the brackets.

async getSpecificEventInfo(eventId) {
        return await EventService.getSpecificEventInfo(eventId);
      }

If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).

1. Declare it(or declare them, it is possible to add multiple params)

const headers = headers: {Authorization: `Bearer ${yourToken}`}

2. Add it inside the brackets and pass it to the function, as shown in the previous example!

Constructors

new EventService()

new EventService(): EventService

Returns

EventService

Methods

changeEventCover()

static changeEventCover(id, data, config?): Promise<SCEventType>

Parameters

Parameter	Type
id	string | number
data	FormData
config?	AxiosRequestConfig<any>

Returns

Promise<SCEventType>

Source

services/event/index.ts:490

---

createEvent()

static createEvent(data, config?): Promise<SCEventType>

Parameters

Parameter	Type
data	EventCreateParams | FormData
config?	AxiosRequestConfig<any>

Returns

Promise<SCEventType>

Source

services/event/index.ts:478

---

deleteEvent()

static deleteEvent(id, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:487

---

getEventFeed()

static getEventFeed(id, params?, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
params?	EventFeedParams
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:475

---

getEventInvitedUsers()

static getEventInvitedUsers(id, params?, config?): Promise <SCPaginatedResponse<SCUserType>>

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:509

---

getEventMembers()

static getEventMembers(id, params?, config?): Promise <SCPaginatedResponse<SCUserType>>

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:493

---

getEventRelated()

static getEventRelated(id, params?, config?): Promise <SCPaginatedResponse<SCEventType>>

Parameters

Parameter	Type
id	string | number
params?	EventRelatedParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCEventType>>

Source

services/event/index.ts:557

---

getEventSubscriptionStatus()

static getEventSubscriptionStatus(id, config?): Promise <SCPaginatedResponse<any>>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<any>>

Source

services/event/index.ts:542

---

getEventSuggestedUsers()

static getEventSuggestedUsers(id, search, config?): Promise <SCPaginatedResponse<SCUserType>>

Parameters

Parameter	Type
id	string | number
search	string
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:503

---

getEventWaitingApprovalSubscribers()

static getEventWaitingApprovalSubscribers(id, params?, config?): Promise <SCPaginatedResponse<SCUserType>>

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:496

---

getEventsSuggestedUsers()

static getEventsSuggestedUsers(search, config?): Promise <SCPaginatedResponse<SCUserType>>

Parameters

Parameter	Type
search	string
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:506

---

getSpecificEventInfo()

static getSpecificEventInfo(id, config?): Promise<SCEventType>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCEventType>

Source

services/event/index.ts:472

---

getUserCretaedEvents()

static getUserCretaedEvents(params?, config?): Promise <SCPaginatedResponse<SCEventType>>

Parameters

Parameter	Type
params?	EventRelatedParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCEventType>>

Source

services/event/index.ts:466

---

getUserEvents()

static getUserEvents(params?, config?): Promise <SCPaginatedResponse<SCEventType>>

Parameters

Parameter	Type
params?	EventUserParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCEventType>>

Source

services/event/index.ts:456

---

getUserSubscribedEvents()

static getUserSubscribedEvents(id, params?, config?): Promise <SCPaginatedResponse<SCEventType>>

Parameters

Parameter	Type
id	string | number
params?	BaseSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCEventType>>

Source

services/event/index.ts:459

---

getUsersGoingToEvent()

static getUsersGoingToEvent(id, params?, config?): Promise <SCPaginatedResponse<SCUserType>>

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:516

---

getUsersNotGoingToEvent()

static getUsersNotGoingToEvent(id, params?, config?): Promise <SCPaginatedResponse<SCUserType>>

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:523

---

goToEvent()

static goToEvent(id, config?): Promise <SCPaginatedResponse<any>>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<any>>

Source

services/event/index.ts:545

---

hideEvent()

static hideEvent(id, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:567

---

inviteOrAcceptEventRequest()

static inviteOrAcceptEventRequest(id, data, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
data	object
data.users	number[]
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:536

---

notGoingToEvent()

static notGoingToEvent(id, config?): Promise <SCPaginatedResponse<any>>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<any>>

Source

services/event/index.ts:551

---

patchEvent()

static patchEvent(id, data, config?): Promise<SCEventType>

Parameters

Parameter	Type
id	string | number
data	SCEventType
config?	AxiosRequestConfig<any>

Returns

Promise<SCEventType>

Source

services/event/index.ts:484

---

removeGoingToEvent()

static removeGoingToEvent(id, config?): Promise <SCPaginatedResponse<any>>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<any>>

Source

services/event/index.ts:548

---

removeInviteEvent()

static removeInviteEvent(id, data, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
data	object
data.users	number[]
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:539

---

removeNotGoingToEvent()

static removeNotGoingToEvent(id, config?): Promise <SCPaginatedResponse<any>>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<any>>

Source

services/event/index.ts:554

---

searchEvents()

static searchEvents(params?, config?): Promise <SCPaginatedResponse<SCEventType>>

Parameters

Parameter	Type
params?	EventSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCEventType>>

Source

services/event/index.ts:469

---

showEvent()

static showEvent(id, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:564

---

subscribeToEvent()

static subscribeToEvent(id, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:530

---

unsubscribeFromEvent()

static unsubscribeFromEvent(id, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:533

---

updateEvent()

static updateEvent(id, data, config?): Promise<SCEventType>

Parameters

Parameter	Type
id	string | number
data	SCEventType
config?	AxiosRequestConfig<any>

Returns

Promise<SCEventType>

Source

services/event/index.ts:481