Obsolete property in send email sample

Open Beginner friendly
#348 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
90/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
azure, javascript
Domain
documentation

Research direction

Open send-email/send-email.js at line 27 and compare the sample with the linked Microsoft documentation. Update the sample so it uses the current email poller status property, then verify the obsolete isStarted reference is gone and the sample still reflects the documented flow.

Written by the indexing model from the issue text.

Description

status:triage

Please provide us with the following information:

This issue is for a: (mark with an x)
- [ ] bug report -> please search issues before submitting
- [ ] feature request
- [x] documentation issue or request
- [ ] regression (a behavior that used to work and stopped in a new release)

poller.getOperationState().isStarted was removed in a version of azure/communication-email as of the official Microsoft documentation points in favor of poller.getOperationState().status !== "running". Reporting this here as the provided sample code still references this older property and may cause issues for developers who do not catch the notice in the documentation and rely solely on this sample.

Reference in MS docs: https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/email/send-email?tabs=windows%2Cconnection-string%2Csend-email-and-get-status-async%2Casync-client&pivots=programming-language-javascript

Issue in sample code file: send-email/send-email.js Line 27

Thanks! We'll be in touch soon.

Dominant language
JavaScript
Stars
107
Forks
207
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Azure-Samples/communication-services-javascript-quickstarts

All issues in Azure-Samples/communication-services-javascript-quickstarts

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.