From 5ad5facc28414ea4b1b82537a0975ae5d979f7c7 Mon Sep 17 00:00:00 2001 From: Zita Szupera Date: Tue, 24 Sep 2024 15:20:52 +0200 Subject: [PATCH] docs: include member limit in query members docs (#1496) --- .../javascript/02-guides/07-query-call-members.mdx | 13 ++++++++++++- .../reactnative/03-core/07-query-call-members.mdx | 13 ++++++++++++- .../docs/React/02-guides/07-query-call-members.mdx | 13 ++++++++++++- 3 files changed, 36 insertions(+), 3 deletions(-) diff --git a/packages/client/docusaurus/docs/javascript/02-guides/07-query-call-members.mdx b/packages/client/docusaurus/docs/javascript/02-guides/07-query-call-members.mdx index e7ecb00c59..d3852e9d0b 100644 --- a/packages/client/docusaurus/docs/javascript/02-guides/07-query-call-members.mdx +++ b/packages/client/docusaurus/docs/javascript/02-guides/07-query-call-members.mdx @@ -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 diff --git a/packages/react-native-sdk/docusaurus/docs/reactnative/03-core/07-query-call-members.mdx b/packages/react-native-sdk/docusaurus/docs/reactnative/03-core/07-query-call-members.mdx index e7ecb00c59..d3852e9d0b 100644 --- a/packages/react-native-sdk/docusaurus/docs/reactnative/03-core/07-query-call-members.mdx +++ b/packages/react-native-sdk/docusaurus/docs/reactnative/03-core/07-query-call-members.mdx @@ -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 diff --git a/packages/react-sdk/docusaurus/docs/React/02-guides/07-query-call-members.mdx b/packages/react-sdk/docusaurus/docs/React/02-guides/07-query-call-members.mdx index e7ecb00c59..d3852e9d0b 100644 --- a/packages/react-sdk/docusaurus/docs/React/02-guides/07-query-call-members.mdx +++ b/packages/react-sdk/docusaurus/docs/React/02-guides/07-query-call-members.mdx @@ -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