Class: SpaceDataset<D>

Space Dataset

Type parameters

Name	Type
D	extends Dataset

Hierarchy

• DatasetClass<D, Space>

  ↳ SpaceDataset

Methods

acceptMember

▸ acceptMember(req): Promise<SpaceMember>

Accept Member on Space.

Parameters

Name	Type	Description
req	Build5Request<SpaceMemberUpsertRequest>	Use Build5Request with data based on SpaceMemberUpsertRequest

Returns

Promise<SpaceMember>

---

addGuardian

▸ addGuardian(req): Promise<Proposal>

Add Guardian on Space.

Parameters

Name	Type	Description
req	Build5Request<SpaceMemberUpsertRequest>	Use Build5Request with data based on SpaceMemberUpsertRequest

Returns

Promise<Proposal>

---

blockMember

▸ blockMember(req): Promise<SpaceMember>

Block Member on Space.

Parameters

Name	Type	Description
req	Build5Request<SpaceMemberUpsertRequest>	Use Build5Request with data based on SpaceMemberUpsertRequest

Returns

Promise<SpaceMember>

---

claim

▸ claim(req): Promise<Transaction>

Claim Space.

Parameters

Name	Type	Description
req	Build5Request<SpaceClaimRequest>	Use Build5Request with data based on SpaceClaimRequest

Returns

Promise<Transaction>

---

create

▸ create(req): Promise<Space>

Create Space.

Parameters

Name	Type	Description
req	Build5Request<SpaceCreateRequest>	Use Build5Request with data based on SpaceCreateRequest

Returns

Promise<Space>

---

declineMember

▸ declineMember(req): Promise<void>

Decline member on Space.

Parameters

Name	Type	Description
req	Build5Request<SpaceMemberUpsertRequest>	Use Build5Request with data based on SpaceMemberUpsertRequest

Returns

Promise<void>

---

getAllUpdatedAfter

▸ getAllUpdatedAfter(updatedAfter, startAfter?): Promise<Space[]>

Get all records updated after unix timestamp.

Parameters

Name	Type
updatedAfter	number
startAfter?	string

Returns

Promise<Space[]>

Inherited from

DatasetClass.getAllUpdatedAfter

---

getAllUpdatedAfterLive

▸ getAllUpdatedAfterLive(updatedAfter, startAfter?): Observable<Space[]>

Get all records updated after unix timestamp. Real time stream.

Parameters

Name	Type
updatedAfter	number
startAfter?	string

Returns

Observable<Space[]>

Inherited from

DatasetClass.getAllUpdatedAfterLive

---

getByField

▸ getByField(fieldName, fieldValue, startAfter?): Promise<Space[]>

Get records by field.

Parameters

Name	Type
fieldName	string | string[]
fieldValue	string | number | boolean | (string | number | boolean)[]
startAfter?	string

Returns

Promise<Space[]>

Inherited from

DatasetClass.getByField

---

getByFieldLive

▸ getByFieldLive(fieldName, fieldValue, startAfter?): Observable<Space[]>

Get records by field. Real time stream.

Parameters

Name	Type
fieldName	string | string[]
fieldValue	string | number | boolean | (string | number | boolean)[]
startAfter?	string

Returns

Observable<Space[]>

Inherited from

DatasetClass.getByFieldLive

---

getBySpace

▸ getBySpace(space, startAfter?): Promise<Space[]>

Get records by space.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Promise<Space[]>

Inherited from

DatasetClass.getBySpace

---

getBySpaceLive

▸ getBySpaceLive(space, startAfter?): Observable<Space[]>

Get records by space. Real time stream.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Observable<Space[]>

Inherited from

DatasetClass.getBySpaceLive

---

getManyById

▸ getManyById(setIds): Promise<Space[]>

Get many records by id.

Parameters

Name	Type
setIds	string[]

Returns

Promise<Space[]>

Inherited from

DatasetClass.getManyById

---

getManyByIdLive

▸ getManyByIdLive(setIds): Observable<Space[]>

Get many records by id. Real time stream.

Parameters

Name	Type
setIds	string[]

Returns

Observable<Space[]>

Inherited from

DatasetClass.getManyByIdLive

---

getPendingSpacesByMemberLive

▸ getPendingSpacesByMemberLive(member, orderBy?, orderByDir?, startAfter?, limit?): Observable<Space[]>

TODO

Parameters

Name	Type
member	string
orderBy	string[]
orderByDir	string[]
startAfter?	string
limit?	number

Returns

Observable<Space[]>

---

getTopByMember

▸ getTopByMember(member, orderBy?, orderByDir?, startAfter?, limit?): Observable<Space[]>

TODO

Parameters

Name	Type
member	string
orderBy	string[]
orderByDir	string[]
startAfter?	string
limit?	number

Returns

Observable<Space[]>

---

id

▸ id(setId): ExactDataSet<D, Space>

Get specific record by id.

Parameters

Name	Type
setId	string

Returns

ExactDataSet<D, Space>

Inherited from

DatasetClass.id

---

join

▸ join(req): Promise<SpaceMember>

Join Space.

Parameters

Name	Type	Description
req	Build5Request<SpaceJoinRequest>	Use Build5Request with data based on SpaceJoinRequest

Returns

Promise<SpaceMember>

---

leave

▸ leave(req): Promise<void>

Leave Space.

Parameters

Name	Type	Description
req	Build5Request<SpaceLeaveRequest>	Use Build5Request with data based on SpaceLeaveRequest

Returns

Promise<void>

---

removeGuardian

▸ removeGuardian(req): Promise<Proposal>

Remove Guardian on Space.

Parameters

Name	Type	Description
req	Build5Request<SpaceMemberUpsertRequest>	Use Build5Request with data based on SpaceMemberUpsertRequest

Returns

Promise<Proposal>

---

unblockMember

▸ unblockMember(req): Promise<void>

Unblock Member on Space.

Parameters

Name	Type	Description
req	Build5Request<SpaceMemberUpsertRequest>	Use Build5Request with data based on SpaceMemberUpsertRequest

Returns

Promise<void>

---

update

▸ update(req): Promise<Proposal>

Update Space.

Parameters

Name	Type	Description
req	Build5Request<SpaceUpdateRequest>	Use Build5Request with data based on SpaceUpdateRequest

Returns

Promise<Proposal>

---

validateAddress

▸ validateAddress(req): Promise<Transaction>

Validate address on Space.

Parameters

Name	Type	Description
req	Build5Request<AddressValidationRequest>	Use Build5Request with data based on AddressValidationRequest

Returns

Promise<Transaction>