code-push/docs/node.html at gh-pages · r2dev/code-push

History

856 lines (426 loc) · 30.4 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

<!DOCTYPE html>

<head>

<title>

Management SDK · CodePush

</title>

</head>

<body>

<span class="sr-only">Toggle navigation</span>

</button>

<sup class="navbar-logo-text">PREVIEW</sup>

</image>

</a>

</div>

<li class=""><a href="/code-push/index.html#getting_started">Getting Started</a></li>

<li class="active"><a href="/code-push/docs/index.html">Documentation</a></li>

<li class=""><a href="/code-push/community/friends.html">Showcase</a></li>

</ul>

</div>

</div>

</nav>

</header>

<h2 class="site-toc-title">Table of Contents</h2>

<li>

Getting Started

</a>

</li>

<li>

Tutorials

</a>

</li>

<li>

Management CLI

</a>

</li>

<li>

Management SDK

</a>

</li>

<li>

Cordova Client SDK

</a>

</li>

<li>

React Native Client SDK

</a>

</li>

<li>

VSTS Extension

</a>

</li>

</ul>

</div>

<h2 class="site-toc-title">Table of Contents</h2>

Select topic

</a>

<li>

<a href=/code-push/docs/getting-started.html>Getting Started</a>

</li>

<li>

<a href=/code-push/docs/tutorials.html>Tutorials</a>

</li>

<li>

<a href=/code-push/docs/cli.html>Management CLI</a>

</li>

<li>

<a href=/code-push/docs/node.html>Management SDK</a>

</li>

<li>

<a href=/code-push/docs/cordova.html>Cordova Client SDK</a>

</li>

<li>

<a href=/code-push/docs/react-native.html>React Native Client SDK</a>

</li>

<li>

<a href=/code-push/docs/vsts-extension.html>VSTS Extension</a>

</li>

</ul>

</div>

</nav>

</div>

<h1 class="doc-title">Management SDK</h1>

</header>

<p>A JavaScript library for programmatically managing your CodePush account (e.g. creating apps, promoting releases), which allows authoring Node.js-based build and/or deployment scripts, without needing to shell out to the <a href="https://github.com/Microsoft/code-push/blob/master/cli/README.md">CLI</a>.</p>

<h2>Getting Started</h2>

<ol>

<li><p>Create an access key to authenticate with the CodePush server using the following CodePush CLI command:</p>

<div class="highlight"><pre><code class="language-shell" data-lang="shell">code-push access-key add "DESCRIPTION_OF_THE_KEY"

</code></pre></div>

<p>If you already created a key that you want to use here, then you can retrieve it by running <code>code-push access-key ls</code> and using the value of the <code>Key</code> column for the key you wish to use.</p></li>

<li><p>Install the management SDK by running <code>npm install code-push --save</code></p></li>

<li><p>Import it using the following statement (using ES6 syntax as applicable):</p>

<div class="highlight"><pre><code class="language-javascript" data-lang="javascript">var CodePush = require("code-push");

</code></pre></div></li>

<li><p>Create an instance of the <code>CodePush</code> class, passing it the access key you created or retrieved in step #1:</p>

<div class="highlight"><pre><code class="language-javascript" data-lang="javascript">var codePush = new CodePush("YOUR_ACCESS_KEY");

</code></pre></div></li>

<li><p>Begin automating the management of your account! For more details on what you can do with this <code>codePush</code> object, refer to the API reference section below.</p></li>

</ol>

<h2>API Reference</h2>

<p>The <code>code-push</code> module exports a single class (typically referred to as <code>CodePush</code>), which represents a proxy to the CodePush account management REST API. This class has a single constructor for authenticating with the CodePush service, and a collection of instance methods that correspond to the commands in the management <a href="https://github.com/Microsoft/code-push/blob/master/cli/README.md">CLI</a>, which allow you to programmatically control every aspect of your CodePush account.</p>

<h3>Constructors</h3>

<ul>

<li><strong>CodePush(accessKey: string)</strong> - Creates a new instance of the CodePush management SDK, using the specified access key to authenticated with the server.</li>

</ul>

<h3>Methods</h3>

<ul>

<li><p><strong>addAccessKey(description: string): Promise<AccessKey></strong> - Creates a new access key with the specified description (e.g. “VSTS CI”).</p></li>

<li><p><strong>addApp(appName: string, os: string, platform: string, manuallyProvisionDeployments: boolean = false): Promise<App></strong> - Creates a new CodePush app with the specified name, os, and platform. If manuallyProvisionDeployments is set to true, the app will not create the default deployments of “Staging” and “Production”; if unspecified or set to false, it will.</p></li>

<li><p><strong>addCollaborator(appName: string, email: string): Promise<void></strong> - Adds the specified CodePush user as a collaborator to the specified CodePush app.</p></li>

<li><p><strong>addDeployment(appName: string, deploymentName: string): Promise<Deployment></strong> - Creates a new deployment with the specified name, and associated with the specified app.</p></li>

<li><p><strong>clearDeploymentHistory(appName: string, deploymentName: string): Promise<void></strong> - Clears the release history associated with the specified app deployment.</p></li>

<li><p><strong>getAccessKey(accessKey: string): Promise<AccessKey></strong> - Retrieves the metadata about the specific access key.</p></li>

<li><p><strong>getAccessKeys(): Promise<AccessKey[]></strong> - Retrieves the list of access keys associated with your CodePush account.</p></li>

<li><p><strong>getApp(appName: string): Promise<App></strong> - Retrieves the metadata about the specified app.</p></li>

<li><p><strong>getApps(): Promise<App[]></strong> - Retrieves the list of apps associated with your CodePush account.</p></li>

<li><p><strong>getCollaborators(appName: string): Promise<CollaboratorMap></strong> - Retrieves the list of collaborators associated with the specified app.</p></li>

<li><p><strong>getDeployment(appName: string, deploymentName: string): Promise<Deployment></strong> - Retrieves the metadata for the specified app deployment.</p></li>

<li><p><strong>getDeploymentHistory(appName: string, deploymentName: string): Promise<Package[]></strong> - Retrieves the list of releases that have been made to the specified app deployment.</p></li>

<li><p><strong>getDeploymentMetrics(appName: string, deploymentName): Promise<DeploymentMetrics></strong> - Retrieves the installation metrics for the specified app deployment. </p></li>

<li><p><strong>getDeployments(appName: string): Promose<Deployment[]></strong> - Retrieves the list of deployments associated with the specified app.</p></li>

<li><p><strong>patchRelease(appName: string, deploymentName: string, label: string, updateMetadata: PackageInfo): Promise<void></strong> - Updates the specified release’s metadata with the given information.</p></li>

<li><p><strong>promote(appName: string, sourceDeploymentName: string, destinationDeploymentName: string, updateMetadata: PackageInfo): Promise<void></strong> - Promotes the latest release from one deployment to another for the specified app and updates the release with the given metadata.</p></li>

<li><p><strong>release(appName: string, deploymentName: string, updateContentsPath: string, targetBinaryVersion: string, updateMetadata: PackageInfo): Promise<void></strong> - Releases a new update to the specified deployment with the given metadata.</p></li>

<li><p><strong>removeAccessKey(accessKey: string): Promise<void></strong> - Removes the specified access key from your CodePush account.</p></li>

<li><p><strong>removeApp(appName: string): Promise<void></strong> - Deletes the specified CodePush app from your account.</p></li>

<li><p><strong>removeCollaborator(appName: string, email: string): Promise<void></strong> - Removes the specified account as a collaborator from the specified app.</p></li>

<li><p><strong>removeDeployment(appName: string, deploymentName: string): Promise<void></strong> - Removes the specified deployment from the specified app.</p></li>

<li><p><strong>renameApp(oldAppName: string, newAppName: string): Promise<void></strong> - Renames an existing app.</p></li>

<li><p><strong>renameDeployment(appName: string, oldDeploymentName: string, newDeploymentName: string): Promise<void></strong> - Renames an existing deployment within the specified app.</p></li>

<li><p><strong>rollback(appName: string, deploymentName: string, targetRelease?: string): Promise<void></strong> - Rolls back the latest release within the specified deployment. Optionally allows you to target a specific release in the deployment’s history, as opposed to rolling to the previous release.</p></li>

</ul>

<h3>Error Handling</h3>

<p>When an error occurs in any of the methods, the promise will be rejected with a CodePushError object with the following properties:</p>

<ul>

<li><strong>message</strong>: A user-friendly message that describes the error.</li>

<li><strong>statusCode</strong>: An HTTP response code that identifies the category of error:

<ul>

<li><strong>CodePush.ERROR_GATEWAY_TIMEOUT</strong>: A network error prevented you from connecting to the CodePush server.</li>

<li><strong>CodePush.ERROR_INTERNAL_SERVER</strong>: An error occurred internally on the CodePush server.</li>

<li><strong>CodePush.ERROR_NOT_FOUND</strong>: The resource you are attempting to retrieve does not exist.</li>

<li><strong>CodePush.ERROR_CONFLICT</strong>: The resource you are attempting to create already exists.</li>

<li><strong>CodePush.ERROR_UNAUTHORIZED</strong>: The access key you configured is invalid or expired.</li>

</ul></li>

</ul>

</article>

<h3>Server trouble... ☹</h3>

</div>

<P>We appreciate the effort but we are having issues.</P>

</div>

<h3>Thank you!</h3>

</div>

<P>We appreciate your feedback.</P>

</div>

<h3>Additional feedback</h3>

</div>

<button type="submit" onclick="updateFeed(true)">Submit</button>

</div>

<h3> Was this documentation helpful?</h3>

</div>

</div>

var baseURL="https://docsfeedback.azurewebsites.net/api/feedback/";

var feedbackType, messageId;

var docURL = window.location.host+window.location.pathname;

var date = new Date().toUTCString();

var project = "CodePush";

function sendFeed(feedType){

feedbackType = feedType;

$.ajax({

method: "POST",

contentType: "application/x-www-form-urlencoded",

crossDomain: true,

cors: true,

url: baseURL+"create",

data: { Type: feedbackType, ParentURL: docURL, Project: project, CreationDate: date, Id: messageId}

})

.done(function(result, textStatus, xhr) {

messageId = xhr.responseJSON.Id;

$('.widget-entry').css('display','none');

$('.widget-message').css('display','block');

})

.fail(function(req, status, error ) {

console.log( 'Something went wrong - ', status, error );

$('.widget-entry').css('display','none');

$('.widget-error').css('display','block');

});

}

function updateFeed(msg){

var comments = $('.widget-text').val();

if(msg){

$.ajax({

method: "PUT",

contentType: "application/x-www-form-urlencoded",

crossDomain: true,

cors: true,

url: baseURL+messageId,

data: { Type: feedbackType, ParentURL: docURL, Project: project, CreationDate: date, Id: messageId, Message: comments}

})

.done(function() {

$('.widget-message').css('display','none');

$('.widget-thankyou').css('display','block');

})

.fail(function(req, status, error ) {

console.log( 'Something went wrong - ', status, error );

$('.widget-message').css('display','none');

$('.widget-error').css('display','block');

});

}

else{

$('.widget-message').css('display','none');

$('.widget-thankyou').css('display','block');

}

setTimeout(function(){

$('.widget').fadeTo( "slow", 0);

},4000);

}

</script>

</div>

<h4>General</h4>

<li><a href="https://github.com/Microsoft/code-push/blob/master/LICENSE.md" target="_blank">License</a></li>

<li><a href="https://www.visualstudio.com/en-us/privacy-policy-vs" target="_blank">Privacy</a></li>

<li><a href="https://msdn.microsoft.com/en-us/cc300389" target="_blank">Terms of Service</a></li>

</ul>

</div>

<h4>Community</h4>

<li><a href="https://github.com/Microsoft/code-push/" target="_blank">GitHub Project</a></li>

<li><a href="https://stackoverflow.com/questions/tagged/codepush" target="_blank">Stack Overflow</a></li>

<li><a href="https://twitter.com/hashtag/codepush" target="_blank">#CodePush</a></li>

</ul>

</div>

<h4>Documentation</h4>

<li><a href="https://github.com/Microsoft/cordova-plugin-code-push/blob/master/README.md" target="_blank">Cordova Plugin Docs</a></li>

<li><a href="https://github.com/Microsoft/react-native-code-push/blob/master/README.md" target="_blank">React Native Plugin Docs</a></li>

</ul>

</div>

<p>If you have any feedback or suggestions on how we can make CodePush more awesome, please contact via Twitter <a href="https://twitter.com/mscodepush">@mscodepush, <a href=mailto:[email protected]>email us</a> or ping us in the <a href="https://discord.gg/0ZcbPKXt5bWxFdFu">#code-push</a> channel on Reactiflux (for React Native).</p>

</div>

<p class="pull-left hidden-xs">Made with <span class="glyphicon glyphicon-heart"></span> in Redmond</p>

</div>

</footer>

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){

(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),

m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)

})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-68566566-1', 'auto');

// strip off trailing slashes

var pathnameWithoutTrailingSlash = window.location.pathname.toLowerCase();

var pathnameLength = pathnameWithoutTrailingSlash.length;

if (pathnameLength > 1 && pathnameWithoutTrailingSlash.lastIndexOf("/") == pathnameLength - 1) {

pathnameWithoutTrailingSlash = pathnameWithoutTrailingSlash.substring(0, pathnameLength - 1);

}

ga("send", "pageview", pathnameWithoutTrailingSlash);

window.onhashchange = function () {

ga("send", "pageview", window.location.pathname.toLowerCase() + window.location.hash);

};

</script>

</body>

</html>

FilesExpand file tree

node.html

Latest commit

History

node.html

File metadata and controls