Module message

Source

Expand description

Message types for the Zulip API.

Modules§

delete_message
edit_message: Types and functions for the edit message API.
emoji_reaction: Emoji reaction endpoint request and response.
fetch_api_key: Fetch API key request and response types.
get_file_temporary_url: Request and response types for the Upload File Temporary endpoint.
get_message: Request and response types for the Get Message endpoint.
get_message_history: Request and response types for the Get Message History endpoint.
get_messages: Types and functions for the Get Messages Zulip API endpoint.
get_read_receipts: Request and response types for the Get Read Receipts endpoint.
mark_all_as_read: Response type for the Mark All as Read endpoint.
mark_stream_as_read: Request and response types for the Mark Stream as Read endpoint.
mark_topic_as_read: Request and response types for the Mark Topic as Read endpoint.
matches_narrow: Request and response types for the Matches Narrow endpoint.
register: Register endpoint request and response.
render: Render API request and response.
report_message: Request and response types for the Report Message endpoint.
response: Zulip API response types.
send_message: Types and functions for the message sending API.
update_message_flags: Request and response types for the Update Message Flags endpoint.
update_message_flags_narrow: Request and response types for the Update Message Flags Narrow endpoint.
upload_file: Types and functions for the upload files API.

Structs§

Attachment: Represents metadata for a attachment in a Zulip message.
AttachmentMessage: Represents metadata for a attachment message in a Zulip message.
BasicChannel: Represents basic details about the channel.
Bot: Represents a Zulip bot.
BotServiceEmbedded: Represents when the bot is an embedded bot.
BotServiceOutgoingWebhook: Represents when the bot is an outgoing webhook.
CanAddSubscribersGroup: Represents a group-setting value defining the set of users who have permission to add subscribers to this channel.
CanAdministerChannelGroup: Represents A group-setting value defining the set of users who have permission to administer this channel.
CanDeleteAnyMessageGroup: Represents a group-setting value defining the set of users who have permission to delete any message in the channel.
CanDeleteOwnMessageGroup: Represents a group-setting value defining the set of users who have permission to delete the messages that they have sent in the channel.
CanMoveMessagesOutOfChannelGroup: Represents a group-setting value defining the set of users who have permission to move messages out of this channel.
CanMoveMessagesWithinChannelGroup: Represents a group-setting value defining the set of users who have permission to move messages within this channel.
CanRemoveSubscribersGroup: Represents A group-setting value defining the set of users who have permission to remove subscribers from this channel.
CanResolveTopicsGroup: Represents a group-setting value defining the set of users who have permission to resolve topics in the channel.
CanSendMessageGroup: Represents a group-setting value defining the set of users who have permission to post in this channel.
CanSubscribeGroup: Represents a group-setting value defining the set of users who have permission to subscribe themselves to this channel.
ChannelFolder: Represents the channel folder’s attributes.
ClientCapabilities: Represents details on features the client supports that are relevant to the format of responses sent by the server.
CrossRealmBot: Represents the Cross-realm bot field of the response to a Register Zulip API request.
CustomProfileField: Represents the details of a custom profile field configured for this organization.
CustomProfileFieldType: Represents the details of the field type with the field type as the name of the property itself. The current supported field types are as follows:
DefaultChannelGroup: Represents details of a default channel group.
Draft: Represents a message draft.
EditHistory: Represents a the edit history of a message returned by the Zulip API server.
GiphyRatingOption: Represents the details of the rating with the name of the rating as the key.
GroupPermissionSetting: Represents configuration for a group permission setting specifying the groups to which the setting can be set to and the default values for the setting.
GroupSettingIds: GroupSettingValueOneOf : An object with these fields:
LegacyPresenceFormat: Represents the details of the user’s presence.
Message: Represents a message returned by the Zulip API server.
ModernPresenceFormat: Represents presence data (modern format) for the user with the specified ID.
MutedTopic: Represents a muted topic.
MutedUser: Represents the user ID and timestamp of a muted user.
NavigationView: Represents a user’s personal configuration for a specific navigation view.
NeverSubscribed: Represents one of the channels that is visible to the user, and the user has never been subscribed to.
OnboardingStep: OnboardingStep : Dictionary containing details of a single onboarding step.
ProfileData: Represents data about what value the user filled in the custom profile field with that ID.
PushDevice: Represents the details of a push device with the push account ID as the key.
Reaction: Represents a reaction to a Zulip message.
RealmAuthenticationMethod: Represents the properties of an authentication method for the organization - its enabled status and availability for use by the organization.
RealmAvailableVideoChatProvider: Represents the details of the video call provider with the name of the chat provider as the key.
RealmBilling: Represents billing information of the organization.
RealmDefaultExternalAccount: Represents the details of the default external account provider with the name of the website as the key.
RealmDomain: Represents details of the newly added domain.
RealmEmbeddedBot: Represents details of an embedded bot. Embedded bots are an experimental feature not enabled in production yet.
RealmEmoji: Represents details about the emoji with the specified ID. It has the following properties:
RealmFilter: Represents a legacy property for linkifiers.
RealmIncomingWebhookBot: Represents details of the incoming webhook bot.
RealmLinkifier: Represents the realm linkifier list item.
RealmPlayground: Represents details about a realm playground.
RealmUserSettingsDefault: Represents the default values of settings for new users.
RecentPrivateConversation: Represents a single recent direct conversation in the user’s history.
SavedSnippet: Represents details of the saved snippet.
ScheduledMessage: Represents a scheduled message.
ServerSupportedPermissionSetting: Represents metadata detailing the valid values for permission settings that use group-setting values.
ServerThumbnailFormat: Represents details of the server thumbnail image format.
Submessage: Represents a message returned by the Zulip API server.
Subscription: Represents the properties of a channel the user is subscribed to (as well as that user’s personal per-channel settings).
TopicLink: Represents metadata for a link included on a Zulip topic.
UnreadMsgs: Represents a set of data structures describing the conversations containing the 50000 most recent unread messages the user has received.
UnreadMsgsHuddle: Represents details of unread group direct messages with a specific group of users.
UnreadMsgsPm: Represents details of unread one-on-one direct messages with a specific user.
UnreadMsgsStream: Represents details of all unread messages of a single subscribed channel.
User: Represents basic data on a given Zulip user.
UserGroup: Represents the user group’s attributes.
UserRecipient: Represents metadata for a user who was displayed a message.
UserSettings: Represents the user’s personal settings.
UserSettingsEmojisetChoice: Represents the description of an emoji set.
UserStatus: Represents the status details of a user with the key of the object being the ID of the user.
UserTopic: Represents the user’s configuration for a given topic.
WebhookConfigOption: Represents webhook config option details.
WebhookUrlOption: Represents an optional URL parameter options for the incoming webhook integration.

Enums§

AutomaticallyFollowTopicsPolicy: Which topics to follow automatically.
AutomaticallyUnmuteTopicsInMutedStreamsPolicy: Which topics to unmute automatically in muted channels.
BotService: Represents extra configuration details for the bot.
BotType: Represents a bot type.
ColorScheme: Controls which color theme to use.
ContentType: Represents the content type of a Zulip message.
DemoteInactiveStreams: Whether to hide inactive channels in the left sidebar.
DesktopIconCountDisplay: Unread count badge (appears in desktop sidebar and browser tab).
DisplayRecipient: Represents the metadata for recipients who were displayed a message.
DraftType: Represents the Draft type.
EmailAddressVisibility: The policy for which other users in this organization can see the user’s real email address.
Emojiset: Represents The user’s configured emoji set, used to display emoji to the user everywhere they appear in the UI.
EventType: A JSON-encoded array indicating which types of events you’re interested in. Values that you might find useful include:
Flag: Represents an available Zulip message flag.
GroupSetting: Represents a group setting value.
IncludeSubscribers: Whether each returned channel object should include a subscribers field containing a list of the user IDs of its subscribers.
LegacyPresenceStatus: The status of the user on this client. Will be either "idle" or "active".
MessageTo: Represents the recipient for the Zulip message.
MessageType: Represents a Zulip message type.
OnboardingType: Represents the OnboardingStep type.
Operation: Represents whether to add or remove a flag.
OutgoingWebhookInterface: Represents An integer indicating what format requests are posted in
Presence: Represents one of these two formats (modern or legacy) for user presence data:
PropagateMode: Represents the propagation mode on a Zulip server.
PushDeviceStatus: Represents the push account’s registration status.
ReactionType: Represents the type of Reaction.
RealmCreatePrivateStreamPolicy: A deprecated representation of a superset of the users who have permission to create private channels in the organization, available for backwards-compatibility.
RealmCreatePublicStreamPolicy: A deprecated representation of a superset of the users who have permission to create private channels in the organization, available for backwards-compatibility.
RealmCreateWebPublicStreamPolicy: A deprecated representation of a superset of the users who have permission to create web-public channels in the organization, available for backwards-compatibility.
RealmMessageEditHistoryVisibilityPolicy: What typesof message edit history are accessible to users via message edit history.
RealmNameInEmailNotificationsPolicy: Whether to include organization name in subject of message notification emails.
RealmOrganizationType: Represents the organization type for the realm. Useful only to clients supporting changing this setting for the organization, or clients implementing onboarding content or other features that varies with organization type.
RealmPlanType: Represents the plan type of the organization.
RealmVideoChatProvider: Present if realm is present in fetch_event_types.
RealmWildcardMentionPolicy: A deprecated representation of a superset of the users who have permission to use wildcard mentions in large channels, available for backwards-compatibility.
ReportType: Represents the reason that best describes why the current user is reporting the target message for moderation.
ResolvedTopicNoticeAutoReadPolicy: Controls whether the resolved-topic notices are marked as read.
Role: Represents a user role.
ScheduledMessageTo: Represents the scheduled message’s tentative target audience.
ScheduledMessageType: Represents the ScheduledMessage type.
StreamPostPolicy: Represents A deprecated representation of a superset of the users who have permission to post messages to the channel available for backwards-compatibility.
TopicsPolicy: Represents whether named topics and the empty topic are enabled in a channel.
UserListStyle: The style selected by the user for the right sidebar user list.
WebAnimateImagePreviews: Controls how animated images should be played in the message feed in the web/desktop application.
WebChannelDefaultView: Web/desktop app setting controlling the default navigation behavior when clicking on a channel link.
WebHomeView: Represents the home view used when opening a new Zulip web app window or hitting the Esc keyboard shortcut repeatedly.
WebMarkReadOnScrollPolicy: Whether or not to mark messages as read when the user scrolls through their feed.
WebStreamUnreadsCountDisplayPolicy: Configuration for which channels should be displayed with a numeric unread count in the left sidebar.

Type Aliases§

PresenceList: Represents the collection of Presence entries.

Module message

Module message Copy item path

Modules§

Structs§

Enums§

Type Aliases§

Module message