Skip to content

Commit d527f3d

Browse files
mnorman-msmnorman-ms
committed
Responding to review, adding missing resource, and noting inheritance.
1 parent d0c8b8b commit d527f3d

File tree

5 files changed

+86
-20
lines changed

5 files changed

+86
-20
lines changed

‎api-reference/beta/resources/print-overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The cloud printing API provides the following key features.
2525

2626
## Print devices
2727

28-
The [printerShare](./printershare.md) and [printer](./printer.md) resources define the public view and the actual printer for physical printers that are discoverable by users and applications. The printer share is a logical view of a printer resource that represents a physical printer. The underlying physical printer can be changed without changing the printer share, which enables organizations to maintain high printer availability.
28+
The [printerShare](./printershare.md) and [printer](./printer.md) resources define the public view and the actual printer for physical printers that are discoverable by users and applications. A **printerShare** is a logical view of **printer** resources that represent physical printers. The underlying physical printers can be changed without changing the printer share, which enables organizations to maintain high printer availability.
2929

3030
The **printerShare** resource contains properties and methods that let you manage which users and groups can perform operations on that printer, such as creating or deleting print jobs. You can use the **printer** property to access information about the physical printer, see its status, list and reset its settings, and more.
3131

@@ -40,7 +40,7 @@ You can manage user and group print permissions with Universal Print APIs that o
4040

4141
[printJob](./printjob.md) objects are the basic unit of work for printing. They have a list of documents to print and another list of [printTask](./printtask.md) objects that describe the print operation to complete. Resources that derive from the [printOperation](./printoperation.md) base resource type, such as [printerCreateOperation](./printercreateoperation.md), represent long-running operations such as creating a new printer.
4242

43-
To print a document, create a print job and pass its unique identifier to [printDocument: createUploadSession](../api/printdocument-createuploadsession.md) after the print task for the print job enters the **processing** state. Then use the session identifier that you received when you created the upload session to send the document to the **document** property of the print job. After this operation completes, you can start the print job to print your document. For more information about uploading documents, see [Upload documents using the Microsoft Graph Universal Print API](/graph/upload-data-to-upload-session).
43+
To print a document, create a **printJob** and pass its unique identifier to [printDocument: createUploadSession](../api/printdocument-createuploadsession.md) after the print task for the print job enters the **processing** state. Then use the session identifier that you received when you created the upload session to send the document to the **document** property of the **printJob**. After this operation completes, you can start the **printjob** to print your document. For more information about uploading documents, see [Upload documents using the Microsoft Graph Universal Print API](/graph/upload-data-to-upload-session).
4444

4545
## Implement pull printing
4646

‎api-reference/beta/resources/printer.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Namespace: microsoft.graph
1313

1414
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1515

16-
Represents a printer device that is registered with the Universal Print service. Printer resources can be used to manage print jobs, printer settings, printer metadata, and registration status.
16+
Represents a printer device that is registered with the Universal Print service. Printer resources can be used to manage print jobs, printer settings, printer metadata, and registration status. Inherits from [printerBase](./printerbase.md).
1717

1818
This resource supports:
1919
* [Subscribing to change notifications](/graph/universal-print-webhook-notifications).
@@ -38,17 +38,17 @@ This resource supports:
3838
| Property | Type | Description |
3939
|:-------------|:------------|:------------|
4040
|id|String|The printer's identifier. Read-only.|
41-
|displayName|String|The name of the printer.|
42-
|manufacturer|String|The manufacturer reported by the printer.|
43-
|model|String|The model name reported by the printer.|
41+
|displayName|String|The name of the printer. Inherited from [printerBase](./printerbase.md).|
42+
|manufacturer|String|The manufacturer reported by the printer. Inherited from [printerBase](./printerbase.md).|
43+
|model|String|The model name reported by the printer. Inherited from [printerBase](./printerbase.md).|
4444
|registeredDateTime|DateTimeOffset|The DateTimeOffset when the printer was registered. Read-only.|
45-
|status|[printerStatus](printerstatus.md)|The processing status of the printer, including any errors.|
45+
|status|[printerStatus](printerstatus.md)|The processing status of the printer, including any errors. Inherited from [printerBase](./printerbase.md).|
4646
|isShared|Boolean|True if the printer is shared; false otherwise. Read-only.|
4747
|hasPhysicalDevice|Boolean|True if the printer has a physical device for printing. Read-only.|
48-
|isAcceptingJobs|Boolean| If `true`, the printer is currently accepting new print jobs.|
49-
|location|[printerLocation](printerlocation.md)|The physical and/or organizational location of the printer.|
50-
|defaults|[printerDefaults](printerdefaults.md)|The printer's default print settings.|
51-
|capabilities|[printerCapabilities](printercapabilities.md)|The capabilities of the printer.|
48+
|isAcceptingJobs|Boolean| If `true`, the printer is currently accepting new print jobs. Inherited from [printerBase](./printerbase.md).|
49+
|location|[printerLocation](printerlocation.md)|The physical and/or organizational location of the printer. Inherited from [printerBase](./printerbase.md).|
50+
|defaults|[printerDefaults](printerdefaults.md)|The printer's default print settings. Inherited from [printerBase](./printerbase.md).|
51+
|capabilities|[printerCapabilities](printercapabilities.md)|The capabilities of the printer. Inherited from [printerBase](./printerbase.md).|
5252
|lastSeenDateTime|DateTimeOffset|The most recent dateTimeOffset when a printer interacted with Universal Print. Read-only.|
5353

5454
## Relationships

‎api-reference/beta/resources/printerbase.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: printerBase resource type
3+
description: Represents the base type for printer and printer share.
4+
author: braedenp-msft
5+
ms.localizationpriority: medium
6+
ms.subservice: universal-print
7+
doc_type: resourcePageType
8+
---
9+
# printerBase resource type
10+
11+
Namespace: microsoft.graph
12+
13+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
14+
15+
Represents the base type for the [printer](printer.md) and [printerShare](printerShare.md) entity types. Inherits from [printerBase](./printerbase.md).
16+
17+
## Properties
18+
|Property|Type|Description|
19+
|:---|:---|:---|
20+
|capabilities|[printerCapabilities](printercapabilities.md)|The capabilities of the printer/printerShare.|
21+
|defaults|[printerDefaults](printerdefaults.md)|The default print settings of printer/printerShare.|
22+
|displayName|String|The name of the printer/printerShare.|
23+
|id|String|The identifier.|
24+
|isAcceptingJobs|Boolean|Specifies whether the printer/printerShare is currently accepting new print jobs.|
25+
|location|[printerLocation](printerlocation.md)|The physical and/or organizational location of the printer/printerShare.|
26+
|manufacturer|String|The manufacturer of the printer/printerShare.|
27+
|model|String|The model name of the printer/printerShare.|
28+
|status|[printerStatus](printerstatus.md)|The processing status of the printer/printerShare, including any errors.|
29+
30+
## Relationships
31+
|Relationship|Type|Description|
32+
|:---|:---|:---|
33+
|jobs|[printJob](printjob.md) collection|The list of jobs that are queued for printing by the printer/printerShare.|
34+
35+
## JSON representation
36+
The following JSON representation shows the resource type.
37+
<!-- {
38+
"blockType": "resource",
39+
"keyProperty": "id",
40+
"@odata.type": "microsoft.graph.printerBase",
41+
"openType": false
42+
}
43+
-->
44+
``` json
45+
{
46+
"@odata.type": "#microsoft.graph.printerBase",
47+
"id": "String (identifier)",
48+
"displayName": "String",
49+
"manufacturer": "String",
50+
"model": "String",
51+
"isAcceptingJobs": "Boolean",
52+
"defaults": {
53+
"@odata.type": "microsoft.graph.printerDefaults"
54+
},
55+
"location": {
56+
"@odata.type": "microsoft.graph.printerLocation"
57+
},
58+
"capabilities": {
59+
"@odata.type": "microsoft.graph.printerCapabilities"
60+
},
61+
"status": {
62+
"@odata.type": "microsoft.graph.printerStatus"
63+
}
64+
}
65+
```
66+

‎api-reference/beta/resources/printershare.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,16 +37,16 @@ Represents a printer that is intended to be discoverable by users and printing a
3737
| Property | Type | Description |
3838
|:-------------|:------------|:------------|
3939
|allowAllUsers|Boolean|If true, all users and groups can access this printer share. This property supersedes the lists of allowed users and groups defined by the **allowedUsers** and **allowedGroups** navigation properties.|
40-
|capabilities|[printerCapabilities](printercapabilities.md)|The capabilities of the printer associated with this printer share.|
40+
|capabilities|[printerCapabilities](printercapabilities.md)|The capabilities of the printer associated with this printer share. Inherited from [printerBase](./printerbase.md).|
4141
|createdDateTime|DateTimeOffset|The DateTimeOffset when the printer share was created. Read-only.|
42-
|defaults|[printerDefaults](printerdefaults.md)|The default print settings of the printer associated with this printer share.|
43-
|displayName|String|The name of the printer share that print clients should display.|
42+
|defaults|[printerDefaults](printerdefaults.md)|The default print settings of the printer associated with this printer share. Inherited from [printerBase](./printerbase.md).|
43+
|displayName|String|The name of the printer share that print clients should display. Inherited from [printerBase](./printerbase.md).|
4444
|id|String| The printerShare's identifier. Read-only.|
45-
|isAcceptingJobs|Boolean|Whether the printer associated with this printer share is currently accepting new print jobs.|
46-
|location|[printerLocation](printerlocation.md)|The physical and/or organizational location of the printer associated with this printer share.|
47-
|manufacturer|String|The manufacturer reported by the printer associated with this printer share. Read-only.|
45+
|isAcceptingJobs|Boolean|Whether the printer associated with this printer share is currently accepting new print jobs. Inherited from [printerBase](./printerbase.md).|
46+
|location|[printerLocation](printerlocation.md)|The physical and/or organizational location of the printer associated with this printer share. Inherited from [printerBase](./printerbase.md).|
47+
|manufacturer|String|The manufacturer reported by the printer associated with this printer share. Read-only. Inherited from [printerBase](./printerbase.md).|
4848
|model|String|The model name reported by the printer associated with this printer share. Read-only.|
49-
|status|[printerStatus](printerstatus.md)|The processing status, including any errors, of the printer associated with this printer share. Read-only.|
49+
|status|[printerStatus](printerstatus.md)|The processing status, including any errors, of the printer associated with this printer share. Read-only. Inherited from [printerBase](./printerbase.md).|
5050
|viewPoint|[printerShareViewpoint](../resources/printershareviewpoint.md)|More data for a printer share as viewed by the signed-in user.|
5151

5252
## Relationships

‎api-reference/v1.0/resources/printerbase.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: printerBase resource type
3-
description: Represents base type for printer and printer share
3+
description: Represents the base type for printer and printer share.
44
author: braedenp-msft
55
ms.localizationpriority: medium
66
ms.subservice: universal-print
@@ -10,7 +10,7 @@ doc_type: resourcePageType
1010

1111
Namespace: microsoft.graph
1212

13-
Represents a base type for [printer](printer.md) and [printerShare](printerShare.md) entity types.
13+
Represents the base type for the [printer](printer.md) and [printerShare](printerShare.md) entity types. Inherits from [printerBase](./printerbase.md).
1414

1515
## Properties
1616
|Property|Type|Description|

0 commit comments

Comments
 (0)