Skip to content

Commit

Permalink
docs: include member limit in query members docs (#1496)
Browse files Browse the repository at this point in the history
  • Loading branch information
szuperaz authored Sep 24, 2024
1 parent d841a3d commit 5ad5fac
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,18 @@ import FilterConditions from '../../../shared/_filter-operators.mdx';
import CallMemberFilters from '../../../shared/video/_call-member-filters.mdx';
import CallMemberSort from '../../../shared/video/_call-member-sort-fields.mdx';

Even though when you create or join a call you get a list of call members, for larger calls this list won't contain all members. To get the complete list of call members the Stream API allows you to query, filter and sort members of a call using a paginated list.
When you create or join a call you get a list of call members, however this can return at most 25 members:

```typescript
// The maximum limit is 25
// The default limit is 25
await call.getOrCreate({ members_limit: 25 });

// or
await call.join({ members_limit: 25 });
```

To get the complete list of call members the Stream API allows you to query, filter and sort members of a call using a paginated list.

## Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,18 @@ import FilterConditions from '../../../shared/_filter-operators.mdx';
import CallMemberFilters from '../../../shared/video/_call-member-filters.mdx';
import CallMemberSort from '../../../shared/video/_call-member-sort-fields.mdx';

Even though when you create or join a call you get a list of call members, for larger calls this list won't contain all members. To get the complete list of call members the Stream API allows you to query, filter and sort members of a call using a paginated list.
When you create or join a call you get a list of call members, however this can return at most 25 members:

```typescript
// The maximum limit is 25
// The default limit is 25
await call.getOrCreate({ members_limit: 25 });

// or
await call.join({ members_limit: 25 });
```

To get the complete list of call members the Stream API allows you to query, filter and sort members of a call using a paginated list.

## Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,18 @@ import FilterConditions from '../../../shared/_filter-operators.mdx';
import CallMemberFilters from '../../../shared/video/_call-member-filters.mdx';
import CallMemberSort from '../../../shared/video/_call-member-sort-fields.mdx';

Even though when you create or join a call you get a list of call members, for larger calls this list won't contain all members. To get the complete list of call members the Stream API allows you to query, filter and sort members of a call using a paginated list.
When you create or join a call you get a list of call members, however this can return at most 25 members:

```typescript
// The maximum limit is 25
// The default limit is 25
await call.getOrCreate({ members_limit: 25 });

// or
await call.join({ members_limit: 25 });
```

To get the complete list of call members the Stream API allows you to query, filter and sort members of a call using a paginated list.

## Examples

Expand Down

0 comments on commit 5ad5fac

Please sign in to comment.