Posts

Use post search when users need to find content across accessible post targets. The SDK exposes semantic post search for natural-language queries on TypeScript, iOS, Android, and Flutter, and hashtag post search for explicit hashtag matching on TypeScript, iOS, and Android.

The current public Flutter SDK source does not expose hashtag post search. Semantic post search is available on Flutter.Flutter semantic post search requires amity_sdk 7.8.7 or later.

Parameters

Parameter	TypeScript	iOS	Android	Flutter
Query	`query`	`query`	`query`	`query`
Target	`targetType`, `targetId`	`targetType`, `targetId`	`targetType`, `targetId`	`targetType`, `targetId`
Data types	`dataTypes`	`dataTypes`	`postTypes`	`postTypes`
Parent-only matching	`matchingOnlyParentPost`	`matchingOnlyParentPost`	`matchingOnlyParentPosts`	`matchingOnlyParentPosts`
Mixed structure	`includeMixedStructure`	`includeMixedStructure`	`includeMixedStructure`	`includeMixedStructure`

Semantic Search Posts

Use semantic search when a natural-language query should match accessible posts for the requested target and data types.

import { PostRepository } from '@amityco/ts-sdk';

let loadNextPage: (() => void) | undefined;
let canLoadMore = false;

const unsubscribe = PostRepository.semanticSearchPosts(
  {
    query: 'healthy breakfast ideas',
    targetType: 'community',
    targetId: communityId,
    dataTypes: ['text', 'image'],
    matchingOnlyParentPost: true,
    includeMixedStructure: false,
    limit: 20,
  },
  ({ data: posts, onNextPage, hasNextPage, loading, error }) => {
    if (loading) return;
    if (error) {
      handleError(error);
      return;
    }

    renderResults(posts);
    loadNextPage = onNextPage;
    canLoadMore = hasNextPage;
  },
);

function loadMorePosts() {
  if (canLoadMore) {
    loadNextPage?.();
  }
}

unsubscribe();

let options = AmityPostSemanticSearchOptions(
    query: "healthy breakfast ideas",
    targetId: communityId,
    targetType: .community,
    dataTypes: ["text", "image"],
    matchingOnlyParentPost: true,
    includeMixedStructure: false
)

token = postRepository
    .semanticSearchPosts(options: options)
    .observe { collection, error in
        if let error {
            handleError(error)
            return
        }

        showSuccessMessage(collection.snapshots.count)
    }

AmitySocialClient.newPostRepository()
    .semanticSearchPosts(
        query = "healthy breakfast ideas",
        targetType = AmityPost.TargetType.COMMUNITY,
        targetId = communityId,
        postTypes = listOf(AmityPost.DataType.TEXT, AmityPost.DataType.IMAGE),
        matchingOnlyParentPosts = true,
        includeMixedStructure = false
    )
    .subscribe(
        { pagingData: PagingData<AmityPost> -> showSuccessMessage(pagingData) },
        { error -> handleGeneralError(error) }
    )

final liveCollection = AmitySocialClient.newPostRepository()
    .semanticSearchPosts(
      query: 'healthy breakfast ideas',
      targetType: AmityPostTargetType.COMMUNITY,
      targetId: communityId,
      postTypes: const [AmityDataType.TEXT, AmityDataType.IMAGE],
      matchingOnlyParentPosts: true,
      includeMixedStructure: false,
    )
    .getLiveCollection(pageSize: 20);

liveCollection.getStreamController().stream.listen((posts) {
  // Render posts in your UI.
});

await liveCollection.loadNext();

Parameter	TypeScript	iOS	Android	Flutter
Hashtags	`hashtags`	`hashtags`	`hashtags`	Not available
Target	`targetType`	Not exposed	Not exposed	Not available
Data types	`dataTypes`	`dataTypes`	`dataTypes`	Not available
Parent-only matching	`matchingOnlyParentPost`	`matchingOnlyParentPost`	Not exposed in the snippet surface	Not available
Mixed structure	`includeMixedStructure`	`includeMixedStructure`	`includeMixedStructure`	Not available

Hashtag Search Posts

Hashtag search finds posts that contain one or more hashtags. Pass hashtag names without the # prefix.

import { PostRepository } from '@amityco/ts-sdk';

let loadNextHashtagPage: (() => void) | undefined;
let canLoadMoreHashtagPosts = false;

const unsubscribe = PostRepository.searchPostsByHashtag(
  {
    targetType: 'community',
    hashtags: ['recipe'],
    dataTypes: ['image'],
    matchingOnlyParentPost: true,
    includeMixedStructure: false,
    limit: 20,
  },
  ({ data: posts, onNextPage, hasNextPage, loading, error }) => {
    if (loading) return;
    if (error) {
      handleError(error);
      return;
    }

    renderResults(posts);
    loadNextHashtagPage = onNextPage;
    canLoadMoreHashtagPosts = hasNextPage;
  },
);

function loadMoreHashtagPosts() {
  if (canLoadMoreHashtagPosts) {
    loadNextHashtagPage?.();
  }
}

unsubscribe();

let options = AmityPostHashtagSearchOptions(
    hashtags: ["recipe"],
    dataTypes: ["image"],
    matchingOnlyParentPost: true,
    includeMixedStructure: false
)

token = postRepository
    .searchPostsByHashtag(options: options)
    .observe { collection, error in
        if let error {
            handleError(error)
            return
        }

        showSuccessMessage(collection.snapshots.count)
    }

AmitySocialClient.newPostRepository()
    .searchPostsByHashtag(
        hashtags = listOf("recipe"),
        dataTypes = listOf(AmityPost.DataType.IMAGE),
        includeMixedStructure = false
    )
    .subscribe(
        { pagingData: PagingData<AmityPost> -> showSuccessMessage(pagingData) },
        { error -> handleGeneralError(error) }
    )

Notes

For semantic post search, provide targetType and targetId together when scoping search to one user or community target.
Use parent-only matching when the UI should show top-level posts instead of child posts from mixed or threaded structures.
For hashtag search, TypeScript requires a targetType; iOS and Android expose hashtag search without a target type parameter. Hashtag search is not available in the Flutter SDK.
On Flutter, getLiveCollection() returns results in server relevance order; call loadNext() to page and dispose() when the screen is torn down. getPagingData(token:, limit:) is available for a one-shot query.
Search results are permission-aware from the backend response, but your UI should still handle empty results and authorization errors.

Query Posts

Query live post collections by target, type, review state, tags, and pagination options.

Feeds and Timelines

Query feed-style post collections for global, custom-ranking, user, and community feeds.

Search Overview

Review SDK search surfaces for community and post discovery.

Powered by

Getting Started

Fundamentals

Social

Chat

Video

Release Notes

Migration Guides

Support

Parameters

Semantic Search Posts

Hashtag Search Filters

Hashtag Search Posts

Notes

Query Posts

Feeds and Timelines

Search Overview

​Parameters

​Semantic Search Posts

​Hashtag Search Filters

​Hashtag Search Posts

​Notes

​Related Topics

Query Posts

Feeds and Timelines

Search Overview

Parameters

Semantic Search Posts

Hashtag Search Filters

Hashtag Search Posts

Notes

Related Topics