Wall

Social wall: posts, comments, likes, pins, follows, and read state.

Endpoints

Endpoint	Arguments	Returns
wall2.edit_comment	ObjectId, ObjectId, unknown	unknown
wall2.edit_post	ObjectId, options	unknown
wall2.follow_post	ObjectId	boolean
wall2.like_post	post_id: string, action: "like" | "unlike"	boolean
wall2.load_comments	post_id: string, comment_id?: string	any | any[]
wall2.load_posts	id?: string, opts?: { multi?: boolean, networks?: Array<cid: string> }	any | any[]
wall2.new_post	{ subject: string, text: string }	unknown
wall2.pin_post	post_id: string, pinned: boolean	boolean
wall2.remove_comment	comment_id: string, post_id: string	boolean
wall2.remove_post	post_id: string	boolean
wall2.save_comment	comment: { text: string }, post_id: string	unknown
wall2.seen	options	object
wall2.unfollow_post	ObjectId	boolean
wall2.unread	options	object

wall2.edit_comment

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (ObjectId, required): feedPostId

Argument 2 (ObjectId, required): feedCommentId

Argument 3 (string, required): comment

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('wall2.edit_comment', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  '507f1f77bcf86cd799439011', // ObjectId (required)
  'string', // comment (required)
]);
console.log(result);

Returns

Undocumented

The return value is not described in the source yet.

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

wall2.edit_post

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (ObjectId, required):

Argument 2 (object, optional):

Field	Type	Required	Description
files	ObjectId[]	no
text	string	yes
subject	string	no
allowReply	boolean	no
recipients	string[]	no	User / Team

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('wall2.edit_post', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  {
    text: 'string',
  },
]);
console.log(result);

Returns

Undocumented

The return value is not described in the source yet.

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

wall2.follow_post

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (ObjectId, required):

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('wall2.follow_post', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);

Returns

boolean

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

wall2.like_post

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (ObjectId, required):

Argument 2 (like` \| `unlike, required): One of: like, unlike.

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('wall2.like_post', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  'like', // argument 2 (required)
]);
console.log(result);

Returns

boolean

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

wall2.load_comments

Description

Load wall post comments

Parameters

Argument 1 (ObjectId, required): feedPostId

Argument 2 (ObjectId, optional): feedCommentId

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('wall2.load_comments', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  '507f1f77bcf86cd799439011', // ObjectId
]);
console.log(result);

Returns

any \| any[]

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

wall2.load_posts

Description

Get wall posts

Parameters

Argument 1 (ObjectId, optional): feedPostId Default: null.

Argument 2 (options, optional):

Field	Type	Required	Description
filter	user[]	no	Default: ["user","announcement"].
sorter	string	no	Default: "time".
multi	boolean	no	Default: false.
networks	ObjectId[]	no	Default: false.
skip	integer	no	Default: 0.
hash	number	no

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('wall2.load_posts', [
  '507f1f77bcf86cd799439011', // ObjectId
  {
    filter: ['user'],
    sorter: 'string',
  },
]);
console.log(result);

Returns

any \| any[]

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

wall2.new_post

Description

Create wallpost to current network

Parameters

Argument 1 (post, required):

Field	Type	Required	Description
subject	string	yes
text	string	yes
files	ObjectId[]	no
loc	object	no
networks	ObjectId[]	no

Argument 2 (string[], optional): User / Team / Network / Group

Argument 3 (Options for feed post, optional):

Field	Type	Required	Description
allowReply	boolean	no
draft	boolean	no
scheduleTime	number	no

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('wall2.new_post', [
  {
    subject: 'string',
    text: 'string',
  },
  ['string'],
  {
    allowReply: false,
    draft: false,
  },
]);
console.log(result);

Returns

Undocumented

The return value is not described in the source yet.

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

wall2.pin_post

Description

Pin wall post to top

Parameters

Argument 1 (ObjectId, required): postId

Argument 2 (boolean, required): pin

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('wall2.pin_post', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  false, // pin (required)
]);
console.log(result);

Returns

boolean

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

wall2.remove_comment

Description

Remove wall post comment

Parameters

Argument 1 (ObjectId, required):

Argument 2 (ObjectId, required):

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('wall2.remove_comment', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
  '507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);

Returns

boolean

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

wall2.remove_post

Description

Remove wall post

Parameters

Argument 1 (ObjectId, required):

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('wall2.remove_post', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);

Returns

boolean

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

wall2.save_comment

Description

Comment on a wall post

Parameters

Argument 1 (object, required):

Field	Type	Required	Description
loc	object	no
tagged	ObjectId[]	no
tags	ObjectId[]	no
files	ObjectId[]	no
text	string	yes

Argument 2 (ObjectId, required): feedPostId

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('wall2.save_comment', [
  {
    text: 'string',
  },
  '507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);

Returns

Undocumented

The return value is not described in the source yet.

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

wall2.seen

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (object, optional):

Field	Type	Required	Description
networks	WorkspaceId[]	no

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('wall2.seen', [
  {
    networks: ['507f1f77bcf86cd799439011'],
  },
]);
console.log(result);

Returns

Field	Type	Required	Description
seen	Date	no
networks	WorkspaceId[]	no

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

wall2.unfollow_post

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (ObjectId, required):

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('wall2.unfollow_post', [
  '507f1f77bcf86cd799439011', // ObjectId (required)
]);
console.log(result);

Returns

boolean

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.

wall2.unread

Description

Undocumented

This endpoint has no description in the source yet.

Parameters

Argument 1 (object, optional):

Field	Type	Required	Description
workspaceIds	WorkspaceId[]	no
types	user | activity.created | activity.updated[]	no

Example

const { Client } = require('@hailer/cli');

const client = await Client.create({
  host: 'https://api.hailer.com',
  username: 'you@example.com',
  password: '••••••',
});

const result = await client.request('wall2.unread', [
  {
    workspaceIds: ['507f1f77bcf86cd799439011'],
    types: ['user'],
  },
]);
console.log(result);

Returns

Field	Type	Required	Description

Auth: requires an authenticated session.

Errors: on failure returns the standard Hailer error object { code, msg, details?, debug? }.