Pinned Posts

Use pinned-post queries to display posts that were already pinned outside the client SDK. The SDK surfaces in this page are read-only retrieval APIs.

Platform Support

Platform	Community pinned posts	Global pinned posts	Placement values
TypeScript	`PostRepository.getPinnedPosts(...)`	`PostRepository.getGlobalPinnedPosts(...)`	String placement such as `default` or `announcement`; `null` fetches all community placements
iOS	`postRepository.getPinnedPosts(...)`	`postRepository.getGlobalPinnedPosts(...)`	`AmityPinPlacement.default.rawValue` or `AmityPinPlacement.announcement.rawValue`
Android	`postRepository.getPinnedPosts(...)`	`postRepository.getGlobalPinnedPosts(...)`	`AmityPinnedPost.PinPlacement.DEFAULT.value` or `ANNOUNCEMENT.value`
Flutter	`AmitySocialClient.newPostRepository().getPinnedPosts(...)`	`getGlobalPinnedPosts()`	String placement, or `PinPlacement.DEFAULT.value` / `ANNOUNCEMENT.value`

Current client SDKs retrieve pinned posts. Pinning and unpinning are not exposed as public client SDK operations in this surface.

Parameters

Operation	Parameter	Required	Platforms	Description
Community pinned posts	`communityId`	Yes	All	Community whose pinned posts should be retrieved.
Community pinned posts	`placement`	No	All	Placement such as default or announcement.
Community pinned posts	`sortBy`	No	TypeScript, iOS	Sort order. Not accepted by the current Android call. Flutter exposes `sortByOptions`, but the request builder does not forward it — do not depend on it.
Community pinned posts	`includeMixedStructure`	No	TypeScript, iOS, Android	Include mixed-structure posts. Not exposed on the current Flutter public method.
Global pinned posts	`includeMixedStructure`	No	TypeScript, iOS, Android	Include mixed-structure posts in global pinned results. Not exposed on the current Flutter public method.

Community Pinned Posts

Query community pinned posts for a specific community and optional placement such as an announcement area.

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

const unsubscribe = PostRepository.getPinnedPosts(
  {
    communityId,
    placement: "announcement",
    sortBy: "lastPinned",
    includeMixedStructure: true,
  },
  ({ data: pinnedPosts, loading, error, onNextPage, hasNextPage }) => {
    if (loading) return;
    if (error) {
      handleError(error);
      return;
    }

    renderResults(pinnedPosts);

    if (hasNextPage) {
      onNextPage?.();
    }
  },
);

token = postRepository
    .getPinnedPosts(
        communityId: communityId,
        placement: AmityPinPlacement.announcement.rawValue,
        sortBy: .lastPinned,
        includeMixedStructure: true
    )
    .observe { collection, error in
        showSuccessMessage(collection.snapshots.count)
    }

postRepository.getPinnedPosts(
    communityId = communityId,
    placement = AmityPinnedPost.PinPlacement.ANNOUNCEMENT.value,
    includeMixedStructure = true
)
    .subscribe(
        { pagingData -> showSuccessMessage(pagingData) },
        { error -> handleGeneralError(error) }
    )

final pinnedPosts = AmitySocialClient.newPostRepository().getPinnedPosts(
  communityId: communityId,
  placement: 'announcement',
);

pinnedPosts.getStreamController().stream.listen((items) {
  final count = items.length;
});

await pinnedPosts.loadNext();

Global Pinned Posts

Query global pinned posts when the product needs an app-wide featured-content surface.

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

const unsubscribe = PostRepository.getGlobalPinnedPosts(
  {
    includeMixedStructure: true,
  },
  ({ data: pinnedPosts, loading, error }) => {
    if (loading) return;
    if (error) {
      handleError(error);
      return;
    }

    renderResults(pinnedPosts);
  },
);

token = postRepository
    .getGlobalPinnedPosts(includeMixedStructure: true)
    .observe { collection, error in
        showSuccessMessage(collection.snapshots.count)
    }

postRepository.getGlobalPinnedPosts(includeMixedStructure = true)
    .subscribe(
        { pinnedPosts -> showSuccessMessage(pinnedPosts.size) },
        { error -> handleGeneralError(error) }
    )

final globalPinnedPosts =
    AmitySocialClient.newPostRepository().getGlobalPinnedPosts();

globalPinnedPosts.getStreamController().stream.listen((items) {
  final count = items.length;
});

await globalPinnedPosts.loadNext();

Notes

Use community pinned posts for a single community feed or announcement area.
Use global pinned posts for app-wide featured content.
TypeScript, iOS, and Android expose includeMixedStructure; the current Flutter public pinned-post methods do not expose that option.
Flutter exposes a sortByOptions parameter on getPinnedPosts, but the current public request builder does not pass it into the request. Do not depend on custom sorting there.

Pin / Feature Controls

Pinning, unpinning, featuring, and unfeaturing are performed from the social.plus Console, not from the client SDK. The client SDKs surface pinned and featured state as read-only.

Event posts in the UIKit follow the same rule and go a step further — the pinned / featured badge renders but there is no in-app pin control in any role, including hosts and moderators. See Event Posts and the Event UIKit doc for how the badge renders.
User-feed posts can never be pinned regardless of role or Console state.
Global featuring requires a public community — a post in a private community cannot be featured globally.

Query Posts

Query regular feed posts.

Viewing Content

Render the pinned post object.

Post Review

Approve or decline posts.

Powered by

Getting Started

Fundamentals

Social

Chat

Video

Release Notes

Migration Guides

Support

Platform Support

Parameters

Community Pinned Posts

Global Pinned Posts

Notes

Pin / Feature Controls

Query Posts

Viewing Content

Post Review

​Platform Support

​Parameters

​Community Pinned Posts

​Global Pinned Posts

​Notes

​Pin / Feature Controls

​Related Topics

Query Posts

Viewing Content

Post Review

Platform Support

Parameters

Community Pinned Posts

Global Pinned Posts

Notes

Pin / Feature Controls

Related Topics