diff --git a/docs/encyclopedia/index.mdx b/docs/encyclopedia/index.mdx index d5d43f3a8c..5ac16c41ad 100644 --- a/docs/encyclopedia/index.mdx +++ b/docs/encyclopedia/index.mdx @@ -13,6 +13,7 @@ The following Encyclopedia pages describe the concepts, components, and features - [Temporal](/temporal) - [Temporal SDKs](/encyclopedia/temporal-sdks) +- [Temporal Client](/temporal-client) - [Workflows](/workflows) - [Activities](/activities) - [Detecting application failures](/encyclopedia/detecting-application-failures) diff --git a/docs/encyclopedia/temporal-client.mdx b/docs/encyclopedia/temporal-client.mdx new file mode 100644 index 0000000000..428137ea76 --- /dev/null +++ b/docs/encyclopedia/temporal-client.mdx @@ -0,0 +1,53 @@ +--- +id: temporal-client +title: Temporal Client +sidebar_label: Temporal Client +description: A Temporal Client acts as the bridge for communication between your applications and the Temporal Service, enabling you to start Workflow Executions, send Signals and Queries, and retrieve results. +slug: /temporal-client +toc_max_heading_level: 4 +keywords: + - client + - explanation + - temporal client + - term +tags: + - Concepts + - Temporal SDKs +--- + +import SdkSvg from '@site/src/components/elements/SdkSvgs/SdkSvg'; + +A Temporal Client allows you to communicate with the [Temporal Service](/temporal-service). + +The most common operations that a Temporal Client allows you to perform are the following: +- Start a Workflow Execution +- Get the result of Workflow Execution +- List Workflow Executions +- Query a Workflow Execution +- Signal a Workflow Execution + +For [Standalone Activities](/standalone-activity), a Temporal Client can also start and manage Standalone Activities directly, without involving a Workflow. + +## SDK guides {/* #sdk-guides */} + +
+ {[ + { name: 'goLangBlock', href: '/develop/go/client/temporal-client', label: 'Temporal Client - Go' }, + { name: 'javaBlock', href: '/develop/java/client/temporal-client', label: 'Temporal Client - Java' }, + { name: 'dotnetBlock', href: '/develop/dotnet/client/temporal-client', label: 'Temporal Client - .NET' }, + { name: 'phpBlock', href: '/develop/php/client/temporal-client', label: 'Temporal Client - PHP' }, + { name: 'pythonBlock', href: '/develop/python/client/temporal-client', label: 'Temporal Client - Python' }, + { name: 'rubyBlock', href: '/develop/ruby/client/temporal-client', label: 'Temporal Client - Ruby' }, + { name: 'rustBlock', href: '/develop/rust/client/temporal-client', label: 'Temporal Client - Rust' }, + { name: 'typeScriptBlock', href: '/develop/typescript/client/temporal-client', label: 'Temporal Client - TypeScript' }, + ].map(({ name, href, label }) => ( + + + + + + + {label} + + ))} +
diff --git a/docs/glossary.md b/docs/glossary.md index e13e98b3d7..f18575809f 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -655,7 +655,7 @@ The Temporal CLI is the most recent version of Temporal's command-line tool. -#### [Temporal Client](/encyclopedia/temporal-sdks#temporal-client) +#### [Temporal Client](/temporal-client) A Temporal Client, provided by a Temporal SDK, provides a set of APIs to communicate with a Temporal Service. diff --git a/sidebars.js b/sidebars.js index 507690da7f..18102f644b 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1272,6 +1272,7 @@ module.exports = { items: [ 'encyclopedia/temporal', 'encyclopedia/temporal-sdks', + 'encyclopedia/temporal-client', { type: 'category', label: 'Workflows',